BigFix Inventory 11

https://help.hcl-software.com/bigfix/11.0/inventory/
Admin
BigFix Inventory is an enterprise software asset management solution that discovers, monitors, and...
Tokens:744,987
Snippets:11,622
Trust Score:10
Update:5 months ago
Show doc for...
Tokens:
Raw
### Run DB2 Setup Script

Source: https://help.hcl-software.com/bigfix/11.0/inventory/Inventory/planinconf/t_installing_db2.html

Execute this script from the extracted directory to start the DB2 installation process. This will launch the DB2 Setup Launchpad.

```bash
./db2setup
```

--------------------------------

### Example of Silent Server Installation Command

Source: https://help.hcl-software.com/bigfix/11.0/inventory/Inventory/planinconf/t_installing_server_silent_lin.html

An example of the silent installation command, specifying the response file path. This command initiates the server installation process without user interaction.

```bash
setup-server-linux-x86_64.sh -f /root/BFI_installer/install_response.txt -i silent
```

--------------------------------

### Example: Get Catalog Version

Source: https://help.hcl-software.com/bigfix/11.0/inventory/Inventory/integration/c_api_associations.html

This example demonstrates how to retrieve the catalog version for software instances using the computer_health association.

```http
GET api/sam/v2/software_instances?columns[]=computer_health.catalog_version
&token=7adc3efb175e2bc0f4484bdd2efca54a8fa04623
```

--------------------------------

### GET /api/sam/v2/software_instances (Association Example)

Source: https://help.hcl-software.com/bigfix/11.0/inventory/Inventory/integration/r_get_software_instances_v2.html

Example of retrieving software instances with associated computer data.

```APIDOC
## GET /api/sam/v2/software_instances (Association Example)

### Description
Retrieves software instances, including associated computer data such as catalog version.

### Method
GET

### Endpoint
/api/sam/v2/software_instances

### Query Parameters
- **columns[]** (string) - Required - Specifies the columns to include in the response. Can be repeated for multiple columns.
- **token** (string) - Required - Authentication token for accessing the API.

### Request Example
```
GET api/sam/v2/software_instances?columns[]=computer_id
&columns[]=computer_health.catalog_version
&token=7adc3efb175e2bc0f4484bdd2efca54a8fa04623
Host: localhost:9081 
Accept: application/json 
Accept-Language: en-US
```

### Response
#### Success Response (200)
- **computer_id** (integer) - Identifier for the computer where the instance is found.
- **catalog_version** (integer) - The catalog version associated with the computer.

#### Response Example
```json
[
{
"computer_id":1,
"catalog_version":1304630
}
]
```
```

--------------------------------

### Example GET Request for License Usages

Source: https://help.hcl-software.com/bigfix/11.0/inventory/Inventory/integration/r_get_license_usage.html

A sample HTTP GET request to the 'api/sam/license_usages' endpoint, including an authentication token.

```HTTP
GET api/sam/license_usages
?token=7adc3efb175e2bc0f4484bdd2efca54a8fa04623
Host: localhost:9081 
Accept: application/json 
Accept-Language: en-US
```

--------------------------------

### Check WinRM Configuration Output

Source: https://help.hcl-software.com/bigfix/11.0/inventory/Inventory/admin/c_troubleshooting_hyperv_connection.html

These are example outputs for 'winrm get winrm/config/client' and 'winrm get winrm/config/service' commands, showing the current WinRM settings.

```text
'winrm get winrm/config/client':
Client:
        NetworkDelayms = 5000
        URLPrefix = wsman
        AllowUnencrypted = true
        Auth
            Basic = true
            Digest = true
            Kerberos = true
            Negotiate = true
            Certificate = true
            CredSSP = false
        DefaultPorts
            HTTP = 5985
            HTTPS = 5986
        TrustedHosts = *

'winrm get winrm/config/service' on the Hyper-V server:
Service:
    RootSDDL = O:NSG:BAD:P(A;;GA;;;BA)(A;;GA;;;S-1-5-21-3273298017-2363932476
    -3643925056-1633)S:P(AU;FA;GA;;;WD)(AU;SA;GWGX;;;WD)
    MaxConcurrentOperations = 4294967295
    MaxConcurrentOperationsPerUser = 15
    EnumerationTimeoutms = 600000
    MaxConnections = 15
    MaxPacketRetrievalTimeSeconds = 120
    AllowUnencrypted = true
    Auth
        Basic = true
        Kerberos = true
        Negotiate = true
        Certificate = true
        CredSSP = false
        CbtHardeningLevel = Relaxed
    DefaultPorts
        HTTP = 5985
        HTTPS = 5986
    IPv4Filter = *
    IPv6Filter = *
    EnableCompatibilityHttpListener = true
    EnableCompatibilityHttpsListener = true
    CertificateThumbprint
```

--------------------------------

### GET /api/sam/v2/software_instances (Additional Columns)

Source: https://help.hcl-software.com/bigfix/11.0/inventory/Inventory/integration/r_get_software_instances_v2.html

Example of retrieving software instances with a subset of columns.

```APIDOC
## GET /api/sam/v2/software_instances (Additional Columns)

### Description
Retrieves a list of software instances, specifying a limited set of columns.

### Method
GET

### Endpoint
/api/sam/v2/software_instances

### Query Parameters
- **columns[]** (string) - Required - Specifies the columns to include in the response. Can be repeated for multiple columns.
- **token** (string) - Required - Authentication token for accessing the API.

### Request Example
```
GET api/sam/v2/software_instances?columns[]=component_name
&columns[]=product_name&columns[]=is_confirmed
&token=7adc3efb175e2bc0f4484bdd2efca54a8fa04623
Host: localhost:9081 
Accept: application/json 
Accept-Language: en-US
```

### Response
#### Success Response (200)
- **component_name** (string) - Name of the software component.
- **product_name** (string) - Name of the product.
- **is_confirmed** (integer) - Indicates if the instance is confirmed (1 for yes, 0 for no).

#### Response Example
```json
[
{
  "component_name":"BigFix Platform Agent",
  "product_name":"BigFix for Power Management",
  "is_confirmed":0
}
]
```
```

--------------------------------

### Example: Get WinRM Client Configuration with HTTPS

Source: https://help.hcl-software.com/bigfix/11.0/inventory/Inventory/admin/t_configuring_winrm.html

An example demonstrating how to retrieve WinRM client configuration using HTTPS, specifying the trusted host, port, administrator credentials, and Negotiate authentication.

```powershell
winrm get winrm/config/client /r:https://
myhyperv.ibm.com:5986/wsman /u:administrator /p:abc /a:Negotiate
```

--------------------------------

### Run Silent Server Installation on Windows

Source: https://help.hcl-software.com/bigfix/11.0/inventory/Inventory/planinconf/t_installing_server_silent_win.html

Use this command to start the silent installation of the BigFix Inventory server on Windows. Ensure the response file path is correct and the RSP_LICENSE_ACCEPTED parameter is set to true in the response file.

```bash
setup-server-windows-x86_64.bat -f response_file_path -i silent
```

```bash
setup-server-windows-x86_64.bat -f "C:\Program Files (x86)\BigFix Enterprise\BES Installers\BFI_installer\install_response.txt" -i silent
```

--------------------------------

### Run Scanner Setup Script

Source: https://help.hcl-software.com/bigfix/11.0/inventory/Inventory/planinconf/t_disc_sys_setup_all.html

Execute the appropriate setup script for your operating system to install the BigFix Inventory scanner. This script automates scanner activation, scheduling of capacity scans, and configuration file creation.

```shell
setup.sh
```

```batch
setup.bat
```

--------------------------------

### Select Installation Type

Source: https://help.hcl-software.com/bigfix/11.0/inventory/Inventory/planinconf/t_installing_bigfix_lin.html

Choose between an evaluation license for a 30-day trial on up to 1000 clients or a production installation using a valid license.

```text
Select the type of installation
	[1] Evaluation: Request a free evaluation license from BigFix. 
This license allows you to install a fully functional copy of the 
BigFix on up to 1000 clients, for a period of 30 days.
[2] Production: Install using a production license or an authorization
1for a production license.
Choose one of the options above or press Enter to accept the default value: [1] 
```

--------------------------------

### GET Request for Raw Unix Package Facts

Source: https://help.hcl-software.com/bigfix/11.0/inventory/Inventory/integration/r_raw_unixpackage.html

This snippet shows an example HTTP GET request to retrieve raw Unix package facts from the BigFix Inventory API. Ensure you replace the token with a valid one for your installation.

```http
GET api/sam/raw_unix_package_facts
?token=7adc3efb175e2bc0f4484bdd2efca54a8fa04623
Host: localhost:9081 
Accept: application/json 
Accept-Language: en-US
```

--------------------------------

### Display Help Information for Server Installation Script

Source: https://help.hcl-software.com/bigfix/11.0/inventory/Inventory/planinconf/t_installing_server_silent_win.html

This command displays help information for the server installation script, useful for understanding available options and parameters.

```bash
setup-server-windows-x86_64.bat -h
```

--------------------------------

### Example Log Entry for Port Conflict

Source: https://help.hcl-software.com/bigfix/11.0/inventory/Inventory/probdet/r_server_install_log.html

This XML snippet shows a typical warning message found in BigFix installation logs, indicating a port conflict that may prevent the server from starting automatically.

```xml
<Message Id="CODIN0215W" Severity="WARN">
 <Time Millis="1381929782997"> 2013-10-16 15:23:02.997+02:00</Time>
 <Server Format="IP">NC040226.kraklab.pl.ibm.com</Server>
 <ProductI>dCOD</ProductI>d
 <Component>Install</Component>
 <ProductInstance></ProductInstance>
 <LogText><![CDATA[CODIN0215W The following ports are in use: 9081, .
The installation process can be continued but the server will not be started. 
The server has to be started manually after resolving the ports conflict.]]></LogText>
 <Source FileName="com.ibm.license.mgmt.install.ia.common.CommunicationCommon" 
 Method="okToContinue"/>
 <TranslationInfo Type="JAVA" Catalog="userLocales.InstallMessageEWI" MsgKey="checkPorts">
 <Param><![CDATA[9081, ]]></Param></TranslationInfo>
 <Principal></Principal>
</Message>
```

--------------------------------

### Display Help Information for Installation Script

Source: https://help.hcl-software.com/bigfix/11.0/inventory/Inventory/planinconf/t_installing_server_silent_lin.html

Use the `-h` option with the server installation script to view available command-line options and usage instructions. This is helpful for understanding script parameters.

```bash
setup-server-linux-x86_64.sh -h
```

--------------------------------

### Run BigFix Inventory scanner setup script

Source: https://help.hcl-software.com/bigfix/11.0/inventory/Inventory/planinconf/t_disc_setup_all.html

Execute the setup_all.sh script from the /cit directory on IBM i to install the BigFix Inventory scanner, run an initial capacity scan, and schedule regular scans. This script automates several installation steps.

```shell
./setup_all.sh
```

--------------------------------

### Example GET request for shared disks

Source: https://help.hcl-software.com/bigfix/11.0/inventory/Inventory/integration/r_get_shared_disks_v2.html

This is an example of a GET request to retrieve shared disk information using an authentication token. Ensure the Host and Accept headers are correctly set.

```HTTP
GET api/sam/v2/shared_disks?token=7adc3efb175e2bc0f4484bdd2efca54a8fa04623
Host: localhost:9081 
Accept: application/json 
Accept-Language: en-US
```

--------------------------------

### Configure Systemd Service for Early Startup

Source: https://help.hcl-software.com/bigfix/11.0/inventory/Inventory/probdet/r_server_operation_problems.html

Add 'After=network-online.target' and 'Wants=network-online.target' to the [Unit] section of the BFIserver.service file to ensure the server starts after the network is online.

```bash
After=network-online.target
Wants=network-online.target
```

--------------------------------

### Example API Request

Source: https://help.hcl-software.com/bigfix/11.0/inventory/Inventory/integration/r_raw_scannedfile.html

An example GET request to the raw_file_facts endpoint, including authentication token and host details.

```HTTP
GET api/sam/raw_file_facts
?token=7adc3efb175e2bc0f4484bdd2efca54a8fa04623
Host: localhost:9081 
Accept: application/json 
Accept-Language: en-US
```

--------------------------------

### Sample Computer.yml with Custom Properties

Source: https://help.hcl-software.com/bigfix/11.0/inventory/Inventory/planinconf/t_disc_sys_scans_software.html

Example of the computer.yml file on Windows after custom properties from computer_custom_properties.yml have been added. Default properties are at the top, and custom properties are at the bottom.

```yaml
endpointID: XXXXXXXX-1111111111
Agent Version: windows 10.0.15.0-20231031-0839
Catalog Version: 2600000.0
Computer Name: XXXXXXXX
Operating System: Windows 10
DNS Name: XXXXXXXX
XXXXXXXX
IP Address: 111.111.1.11
22.222.222.222
My property 1: XYZ1 
My property 2: XYZ2 
111.222.555.666 
My property 3: XYZ3
```

--------------------------------

### Example Command Output for Support

Source: https://help.hcl-software.com/bigfix/11.0/inventory/Inventory/planinconf/r_disc_mnt_troubleshooting.html

This is an example of the command output that should be provided to BigFix Support when a single file import is failing. It shows the full path to the problematic file.

```text
./wlp/usr/servers/server1/tmp/datasources/2/UploadManager/sha1/75/375/isotagsearch_0_375.zip
```

--------------------------------

### Example HTTP GET Request

Source: https://help.hcl-software.com/bigfix/11.0/inventory/Inventory/integration/r_get_saved_reports.html

A sample HTTP GET request to retrieve report data. Ensure the token is valid for authentication.

```http
GET/api/reports/1
&token=a070afeca411d2fs25f5s4c962de2d002b14352f
```

--------------------------------

### Run BigFix Server Installer

Source: https://help.hcl-software.com/bigfix/11.0/inventory/Inventory/planinconf/t_installing_bigfix_lin.html

Navigate to the extracted server installation directory and execute the install script. This initiates the BigFix server installation process.

```bash
./install.sh
```

--------------------------------

### Example HTTP Request

Source: https://help.hcl-software.com/bigfix/11.0/inventory/Inventory/integration/r_raw_metering.html

An example of an HTTP GET request to the BigFix Inventory API, including authentication token and host details.

```HTTP
GET api/sam/raw_app_usage_property_values
?token=7adc3efb175e2bc0f4484bdd2efca54a8fa04623
Host: localhost:9081 
Accept: application/json 
Accept-Language: en-US
```

--------------------------------

### Example HTTP Request for Version

Source: https://help.hcl-software.com/bigfix/11.0/inventory/Inventory/integration/r_get_sua_version.html

An example of an HTTP GET request to the /api/sam/about endpoint, including necessary headers and the authentication token.

```http
GET api/sam/about
?token=7adc3efb175e2bc0f4484bdd2efca54a8fa04623
Host: localhost:9081 
Accept: application/json 
Accept-Language: en-US
```

--------------------------------

### Select License Authorization Type

Source: https://help.hcl-software.com/bigfix/11.0/inventory/Inventory/planinconf/t_installing_bigfix_lin.html

Choose how to set up the installation with a license. Options include using a BES license authorization file, an existing production license, or an existing masthead.

```text
Choose the type of setup that best suits your needs:
[1]  I want to install with a BES license authorization file.
[2]  I want to install with a production license that I already have.
[3]  I want to install with an existing masthead.
Choose one of the options above or press <Enter> to accept the default value: [1]

```

--------------------------------

### Configure DB2 Installation

Source: https://help.hcl-software.com/bigfix/11.0/inventory/Inventory/planinconf/t_installing_bigfix_lin.html

Choose whether to automatically install DB2 from bundled files or use an existing DB2 instance. This step checks for DB2 installation.

```text
DB2 installation check
The installer does not detect if DB2 is installed on the system. 
Specify which option corresponds to your installation:
[1]  DB2 is not installed, install it.
[2]  DB2 is installed, use the installed instance.
[3]  Exit from the installation.
Choose one of the options above or press <Enter> to accept the default value: [1
```

--------------------------------

### Querying Contracts by Maintenance Start Date (Future)

Source: https://help.hcl-software.com/bigfix/11.0/inventory/Inventory/integration/r_common_operators_connectors.html

This example demonstrates how to retrieve future contracts whose maintenance starts in a period of time beginning 1 week from now, using the 'starting' relative date operator.

```APIDOC
## GET /api/sam/contracts

### Description
Retrieves contracts based on their maintenance start date. This example uses the `starting` operator to find contracts with maintenance starting 1 week in the future.

### Method
GET

### Endpoint
`/api/sam/contracts?token=token&criteria={"and":[["maintenance_start","starting","+P1W"]]}`

### Parameters
#### Query Parameters
- **token** (string) - Required - API authentication token.
- **criteria** (object) - Required - JSON object defining the query criteria.
  - **and** (array) - Connector to combine multiple clauses with an AND logic.
    - **maintenance_start** (string) - The field representing the maintenance start date.
    - **starting** (string) - The relative date operator.
    - **+P1W** (string) - The time period: +P1W represents 1 week ahead.

### Request Example
```json
{
  "example": "https://hostname:port/api/sam/contracts?token=token&criteria={"and":[["maintenance_start","starting","+P1W"]]}"
}
```

### Response
#### Success Response (200)
- **data** (array) - List of contracts matching the criteria.
- **count** (integer) - The number of rows retrieved.

#### Response Example
```json
{
  "example": "{\"data\": [...], \"count\": 10}"
}
```
```

--------------------------------

### Example License Usage Response

Source: https://help.hcl-software.com/bigfix/11.0/inventory/Inventory/integration/mapping_software_instances_functions.html

This is an example response from the v2/license_usage API, showing product details and the calculated peak time (`hwm_peak_time`) for license metric utilization.

```json
[{
"product_name": "IBM DB2 Advanced Enterprise Server Edition PVU Option",
"metric_code_name": "PVU_SUB_CAP",
"hwm_quantity": 960,
"hwm_peak_time": "2018-10-11T01:12:26Z"
}]
```

--------------------------------

### GET /api/sam/raw_package_facts

Source: https://help.hcl-software.com/bigfix/11.0/inventory/Inventory/integration/r_raw_package.html

Retrieves raw package facts from the BigFix inventory. This endpoint can be used to get detailed information about installed software packages on managed computers.

```APIDOC
## GET /api/sam/raw_package_facts

### Description
Retrieves raw package facts from the BigFix inventory. This endpoint can be used to get detailed information about installed software packages on managed computers.

### Method
GET

### Endpoint
/api/sam/raw_package_facts

### Query Parameters
- **token** (string) - Required - Authentication token for accessing the API.

### Request Example
```http
GET api/sam/raw_package_facts?token=7adc3efb175e2bc0f4484bdd2efca54a8fa04623 HTTP/1.1
Host: localhost:9081
Accept: application/json
Accept-Language: en-US
```

### Response
#### Success Response (200)
- **package_property_id** (integer) - Unique identifier for the package property.
- **computer_id** (integer) - Identifier for the computer where the package is installed.
- **description** (string) - Description of the package.
- **name** (string) - Name of the software package.
- **version** (string) - Version of the software package.
- **vendor** (string) - Vendor of the software package.
- **valid_from** (string) - Timestamp indicating when the package information became valid.
- **valid_to** (string) - Timestamp indicating when the package information expires.

#### Response Example
```json
{
  "package_property_id": 1,
  "computer_id": 3,
  "description": "{FA7394B8-CE65-4F9E-AC99-F372AD365424}",
  "name": "SQL Server 2008 R2 Database Engine Services",
  "version": "10.50.1600.1",
  "vendor": "Microsoft Corporation",
  "valid_from": "2015-08-05T14:41:19Z",
  "valid_to": "9999-12-31T23:59:59Z"
}
{
  "package_property_id": 1,
  "computer_id": 3,
  "description": "{0AECF03B-E9FC-4A17-999D-6641A2851B26}",
  "name": "BigFix Client",
  "version": "9.2.3.68",
  "vendor": "IBM Corp.",
  "valid_from": "2015-08-05T14:41:19Z",
  "valid_to": "9999-12-31T23:59:59Z"
}
```
```

--------------------------------

### Multiple Instance - Iterator on INSTALL_PATH

Source: https://help.hcl-software.com/bigfix/11.0/inventory/Inventory/softinv/r_extended_signatures_operators.html

Defines how to group information for software installed in multiple instances, iterating on the INSTALL_PATH.

```xml
<MultipleInstance>
  <Iterator name="INSTALL_PATH">
    <FindFilePathEx name=""/>
  </Iterator>
  <Instance>
    <Variable name="IS_INSTALLED"><!-- RULE -->
    </Variable>
    <Condition withVariable="IS_INSTALLED">
      <Action onValue="false" do="SKIP"/>
    </Condition>
  </Instance>
</MultipleInstance>
```

--------------------------------

### Run Silent Server Installation

Source: https://help.hcl-software.com/bigfix/11.0/inventory/Inventory/planinconf/t_installing_server_silent_lin.html

Execute this command to start the silent installation of the BigFix Inventory server on Linux. Replace `response_file_path` with the actual path to your response file.

```bash
setup-server-linux-x86_64.sh -f response_file_path -i silent
```

--------------------------------

### GET Request for Raw Package Facts

Source: https://help.hcl-software.com/bigfix/11.0/inventory/Inventory/integration/r_raw_package.html

This snippet shows a GET request to the raw_package_facts API endpoint. Ensure the token is valid and the host/port are correct for your BigFix installation.

```http
GET api/sam/raw_package_facts
?token=7adc3efb175e2bc0f4484bdd2efca54a8fa04623
Host: localhost:9081 
Accept: application/json 
Accept-Language: en-US
```

--------------------------------

### Example vmm_login for root user

Source: https://help.hcl-software.com/bigfix/11.0/inventory/Inventory/admin/t_vmmanager_adding_connection.html

Use a simple user_name format for the vmm_login parameter when applicable.

```properties
vmm_login=root
```

--------------------------------

### Start DB2 Instance and BigFix Inventory Server

Source: https://help.hcl-software.com/bigfix/11.0/inventory/Inventory/probdet/r_server_operation_problems.html

Log in as the DB2 instance owner to start the DB2 instance, then start the BigFix Inventory server using its command-line interface.

```bash
su db2inst1
db2start
```

```bash
<BFI_installation_folder>/cli/srvstart.sh
```
Tokens:
Raw