### Example JSON Response: Starting

Source: https://github.com/bigfix/developer.bigfix.com/blob/master/site/pages/other/explorer-api/status.md

An example JSON response from the BigFix Explorer Status API when the instance is starting and connecting to the server.

```json
{
    "instanceName": "explorer",
    "status": "Starting",
    "rootServerConnection": "Connecting"
}
```

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

### Begin Prefetch Block Example

Source: https://github.com/bigfix/developer.bigfix.com/blob/master/site/pages/action-script/reference/download/begin-prefetch-block.md

This example demonstrates how to start a prefetch block and add a file item for download. It includes the 'begin prefetch block' command, an 'add prefetch item' command specifying the file's name, SHA1 hash, size, and URL, and concludes with 'end prefetch block'.

```ActionScript
begin prefetch block
add prefetch item name=myfile.txt sha1=09d24c690168f084287af838008cbceca8215425 size=234 url=http://example.com/myfile.txt
end prefetch block
```

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

### BigFix System Options API

Source: https://github.com/bigfix/developer.bigfix.com/blob/master/site/pages/rest-api/iem_cli/iem_samples.md

API documentation for retrieving and setting BigFix system options. Covers commands to get current settings and examples of XML payloads for updating options.

```APIDOC
GET /api/admin/options
  Description: Retrieves current system options.
  Returns: XML containing SystemOptions with MinimumRefreshSeconds and DefaultFixletVisibility.
  Example Response:
    <?xml version="1.0" encoding="UTF-8"?>
    <BESAPI xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xsi:noNamespaceSchemaLocation="BESAPI.xsd">
            <SystemOptions Resource="https://my_computer.my_domain.com:52311/api/admin/options">
                 <MinimumRefreshSeconds>15</MinimumRefreshSeconds>
                 <DefaultFixletVisibility>Visible</DefaultFixletVisibility>
           </SystemOptions>
    </BESAPI>

POST /api/admin/options
  Description: Sets system options. Requires an XML payload.
  Parameters:
    - Request Body: XML file containing SystemOptions to update.
      Example Payload:
      <?xml version="1.0" encoding="UTF-8"?>
      <BESAPI xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xsi:noNamespaceSchemaLocation="BESAPI.xsd">
              <SystemOptions Resource="https://my_computer.my_domain.com:52311/api/admin/options">
                   <MinimumRefreshSeconds>20</MinimumRefreshSeconds>
                   <DefaultFixletVisibility>Hidden</DefaultFixletVisibility>
              </SystemOptions>
      </BESAPI>
  Usage:
    ./iem post /BigFix/SystemOptions.xml admin/options
```

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

### Operating System Examples

Source: https://github.com/bigfix/developer.bigfix.com/blob/master/site/pages/relevance/_reference/docs/world.md

Examples of values returned when querying the 'operating system' property, demonstrating different OS versions and build information.

```BigFix Relevance
Q: operating system
A: Win8.1 6.3.9600

Q: operating system
A: Mac OS X 10.10.2

Q: operating system
A: Linux Ubuntu 14.04.1 LTS (3.13.0-33-generic)
```

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

### Wait Command Examples

Source: https://github.com/bigfix/developer.bigfix.com/blob/master/site/pages/action-script/reference/execution/override.md

Provides practical examples of using the 'wait' command on different platforms. Includes examples for running hidden processes, using 'completion=job', 'disposition=terminate', and running with specific user credentials.

```actionscript
On Windows platforms

This example provides the same functionality as waithidden notepad.exe:

override wait
hidden=true
wait notepad.exe

This example shows how you might run a patch as a hidden process by the current user, waiting for completion of the job before continuing the action script:

override wait
completion=job
hidden=true
runas=currentuser
wait __Download\patch.exe arg1 arg2 arg3

This example shows how you might run a maintenance application, but kill the maintenance process if it isn't finished by the time 1 hour has passed:

override wait
timeout_seconds=3600
disposition=terminate
wait "__Example\maintenance.exe" arg1 arg2 arg3

This example shows how you might install a software application on a Windows machine using the context of a domain user who doesn't belong to the Administrator group. A Take Action Dialog, asking for the user's password, will appear on the console . The password will be passed to the agent as a SecureParameter:

override wait
    	runas=localuser
	asadmin=true
	user=TEM\User1
	password=required
wait c:\IMAGE\SWD\application.exe /SILENT

On non-Windows platforms

override wait
completion=job
wait tar --directory=/tmp -zxvf __Download/myFile.tgz
```

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

### Manage LDAP Directories

Source: https://github.com/bigfix/developer.bigfix.com/blob/master/site/pages/rest-api/iem_cli/iem_samples.md

Commands for retrieving, creating, and deleting LDAP directory configurations. Supports XML format for data exchange. Includes examples for listing all LDAPs, creating a new one with password, getting specific LDAP details, and deleting an LDAP.

```bash
./iem get ldapdirectories
```

```xml
<?xml version="1.0" encoding="UTF-8"?>
<BESAPI xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xsi:noNamespaceSchemaLocation="BESAPI.xsd">
    <LDAPDirectory Resource=" https://my_computer.my_domain.com:52311/ldapdirectory/34">
          <ID>34</ID>
          <Name>AD</Name>
          <IsActiveDirectory>true</IsActiveDirectory>
          <IsGlobalCatalog>true</IsGlobalCatalog>
          <UseSSL>false</UseSSL>
          <BaseDN>DC=tem,DC=test,DC=com</BaseDN>
          <UIDAttribute>userPrincipalName</UIDAttribute>
          <UserFilter>(objectCategory=user)</UserFilter>
          <GroupFilter><![CDATA[(&(objectCategory=group) (groupType:1.2.840.113556.1.4.803:=2147483648))]]></GroupFilter>
          <User>BigFix\Administrator</User>
          <Servers>
            <Server>
                <Host>10.43.5.20</Host>
                <Port>3268</Port>
                <Priority>0</Priority>
            </Server>
          </Servers>
    </LDAPDirectory>
</BESAPI>
```

```bash
./iem post MyLDAP.xml ldapdirectories
```

```xml
<Password>MyLDAP-Password</Password>
```

```bash
./iem get ldapdirectory/34
```

```bash
./iem delete ldapdirectory/34
```

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

### Enabled Startup Item

Source: https://github.com/bigfix/developer.bigfix.com/blob/master/site/pages/relevance/_reference/docs/world.md

No documentation exists.

```relevance
enabled startup item : enableable_file
```

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

### BigFix Server API Installation (Windows)

Source: https://github.com/bigfix/developer.bigfix.com/blob/master/site/pages/other/platform-api/installation.md

Provides step-by-step instructions for installing the BigFix Server API on a Windows system. This includes downloading the installer, running the setup, selecting the installation path, and completing the installation. A reboot of the server is required after installation.

```APIDOC
Project: /bigfix/developer.bigfix.com

Installation Steps:
1. Download the BigFix Server API setup executable (e.g., BigFix-BES-ServerAPI-9.5.xxx.0.exe) from the same source as other BigFix installers. Ensure the version matches your BigFix Server version.
2. Run the downloaded executable to launch the installer.
3. Follow the installer prompts: Click 'Next', select the destination folder for the Server API installation (typically within the BigFix Enterprise folder), click 'Next', and then 'Install'.
4. Upon completion, click 'Finish' to exit the installation wizard.
5. Reboot the server to finalize the installation.
```

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

### BigFix REST API Help and Resource Endpoints

Source: https://github.com/bigfix/developer.bigfix.com/blob/master/site/pages/rest-api/gettingstarted.md

Accessing the BigFix REST API help documentation and specific resource endpoints like 'action'. This shows available HTTP methods (GET, POST, DELETE) and their syntax for interacting with resources.

```APIDOC
GET:
    /api/help
    /api/help/action
    /api/action/{id}
    /api/action/{id}/status
POST:
    /api/action/{id}/stop
DELETE:
    /api/action/{id}
```

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

### Get System Interval

Source: https://github.com/bigfix/developer.bigfix.com/blob/master/site/pages/relevance/_reference/docs/power-history.md

Returns a list of computer states and their start and end times (for example the computer was idle from Wed, 15 Sep 2010 12:30:00 -0700 to Wed, 15 Sep 2010 18:22:00 -0700, which is an interval of 5:52:00).

```relevance
system interval of <power history> : system power interval
```

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

### Run Command Examples

Source: https://github.com/bigfix/developer.bigfix.com/blob/master/site/pages/action-script/reference/execution/run.md

Demonstrates how to execute programs and pass arguments using the 'run' command on different platforms. Quotes around the command line are recommended, especially if file names contain spaces.

```actionscript
run "{pathname of regapp \"wordpad.exe\"}"
run "c:\\winnt\\ftp.exe" ftp.mycorp.net
run wscript /e:vbs x.vbs arg1 arg2
```

```actionscript
run sudo touch "/tmp/example.txt"
```

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

### String Relation Example (Starts With)

Source: https://github.com/bigfix/developer.bigfix.com/blob/master/site/pages/relevance/guide/basics/relations.md

Shows how to use the 'starts with' string relation in Relevance.

```relevance
Q: "nowhere" starts with "now"
A: True
```

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

### Action Parameter Query Syntax and Examples

Source: https://github.com/bigfix/developer.bigfix.com/blob/master/site/pages/action-script/reference/flow-control/action-parameter-query.md

Demonstrates the syntax for the 'action parameter query' command, including specifying parameter names, descriptions, and default values. Provides examples of how to use the command to prompt users for input and utilize the provided values within action scripts, such as running executables or setting registry keys.

```actionscript
action parameter query "InstallationPoint" with description "Please enter the location of the shared installation point:"
run MyTool.exe {parameter "InstallationPoint"}
```

```actionscript
action parameter query "tips" with description "Enter 'on' or 'off' to control Fixlet tips." with default "on"
regset "[HKEY_CURRENT_USER\Software\BigFix]" "tips"="{parameter "tips"}"
```

```actionscript
run "{parameter \"parameter name\"}"
```

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

### Get Specific Site File (GET)

Source: https://github.com/bigfix/developer.bigfix.com/blob/master/site/pages/rest-api/api/site.md

Retrieves a specific site file by its ID. Returns the file content as application/octet-stream. Example URL provided.

```APIDOC
GET /api/site/{site type}/{site name}/file/{file id}
  Description: Gets a site file.
  Request: URL is all that is required.
  Example Request: https://lab.bigfix.me:52311/api/site/master/file/50
  Response: The application/octet-stream of the file.
```

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

### BigFix API Computer Output Example

Source: https://github.com/bigfix/developer.bigfix.com/blob/master/site/pages/rest-api/examples/get-computers.md

This is an example of the XML output returned by the BigFix API when requesting a list of computers. It includes the resource URL, LastReportTime, and ID for each computer.

```xml
<?xml version="1.0" encoding="UTF-8"?>
<BESAPI xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xsi:noNamespaceSchemaLocation="BESAPI.xsd">
    <Computer Resource="https://{server}:{port}/api/computer/11112538">
        <LastReportTime>Wed, 25 May 2016 22:28:03 +0000</LastReportTime>
        <ID>11112538</ID>
    </Computer>
    <Computer Resource="https://{server}:{port}/api/computer/11112539">
        <LastReportTime>Wed, 25 May 2016 22:28:03 +0000</LastReportTime>
        <ID>11112539</ID>
    </Computer>
    <Computer Resource="https://{server}:{port}/api/computer/11112540">
        <LastReportTime>Wed, 25 May 2016 22:28:03 +0000</LastReportTime>
        <ID>11112540</ID>
    </Computer>
</BESAPI>
```

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

### Execute Prefetch Plug-in Example

Source: https://github.com/bigfix/developer.bigfix.com/blob/master/site/pages/action-script/reference/download/execute-prefetch-plug-in.md

Demonstrates how to use the 'execute prefetch plug-in' command to run an external executable that processes an INI file to produce a download manifest. It includes downloading the plugin, executing it with arguments, and adding the generated manifest items.

```ActionScript
begin prefetch block
parameter "ini_file"="{file "server_bf.ini" of site (value of setting "MyCustomSite") of client}"
add prefetch item name=plugin.exe sha1=321381802e1689728e63f25496f8feda98cb3c6e size=1573 url=http://mysite/myplugin.exe
collect prefetch items

// execute the plug-in to produce a manifest from the ini_file:
execute prefetch plug-in "{download path "plugin.exe"}" /downloads "{parameter "ini_file"}" "{download path "manifest"}"
add prefetch item {concatentation " ; " of lines of download file "manifest"}
end prefetch block
```

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

### Example: Location of a File

Source: https://github.com/bigfix/developer.bigfix.com/blob/master/site/pages/relevance/_reference/docs/filesystem-object.md

Gets the directory path where a file is located.

```relevance
Q: location of file "/etc/passwd"
A: /etc
```

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

### Get Computer Properties via API

Source: https://github.com/bigfix/developer.bigfix.com/blob/master/site/pages/rest-api/examples/get-computer.md

Demonstrates how to retrieve specific computer properties from the BigFix console using the REST API. Includes examples for making the request with cURL and Python, and shows the structure of the XML response containing various computer attributes.

```cURL
curl -X GET --user {username}:{password} https://{server}:{port}/api/computer/{id}
```

```Python
import requests
r = requests.get('https://{server}:{port}/api/computer/{id}', auth=('{username}', '{password}'))
print(r.text)
```

```XML
<?xml version="1.0" encoding="UTF-8"?>
<BESAPI xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xsi:noNamespaceSchemaLocation="BESAPI.xsd">
  <Computer Resource="https://localhost:52311/api/computer/{id}">
    <Property Name="Client Settings">_BESClient_EMsg_File=/var/opt/BESClient/besclientdebug.log</Property>
    <Property Name="Client Settings">_BESClient_EMsg_Detail=0</Property>
    <Property Name="Client Settings">__RelayServer1=</Property>
    <Property Name="Client Settings">__RelayServer2=</Property>
    <Property Name="Client Settings">__Relay_Control_Server1=</Property>
    <Property Name="Client Settings">__Relay_Control_Server2=</Property>
    <Property Name="Client Settings">__LockState=false</Property>
    <Property Name="Client Settings">_BESClient_UploadManager_BufferDirectory=/var/opt/BESClient/__BESData/__Global/Upload</Property>
    <Property Name="Client Settings">_BESClient_Resource_StartupNormalSpeed=0</Property>
    <Property Name="Client Settings">_BESRelay_HTTPServer_ServerRootPath=/var/opt/BESServer/wwwrootbes</Property>
    <Property Name="Client Settings">_BESRelay_HTTPServer_PortNumber=52311</Property>
    <Property Name="Client Settings">_BESRelay_HTTPServer_LogFilePath=/var/log/BESRelay.log</Property>
    <Property Name="Client Settings">_BESGather_Download_CheckInternetFlag=1</Property>
    <Property Name="Client Settings">_BESGather_Comm_UseUrlMoniker=0</Property>
    <Property Name="Client Settings">_Enterprise Server_ClientRegister_UDPMessagePort=52311</Property>
    <Property Name="Client Settings">_BESRelay_UploadManager_ParentURL=</Property>
    <Property Name="Client Settings">_BESServer_Database_DSN=BFENT</Property>
    <Property Name="Client Settings">_BESServer_Database_DatabaseAddress=localhost</Property>
    <Property Name="Client Settings">_BESServer_Database_User=db2inst1</Property>
    <Property Name="Client Settings">_BESServer_Database_Password={obf}YmlnZml4</Property>
    <Property Name="Client Settings">_BESServer_Database_Port=50000</Property>
    <Property Name="Client Settings">_BESClient_DeploymentEncoding_IANAName=windows-1252</Property>
    <Property Name="Client Settings">_BESRelay_Log_Verbose=0</Property>
    <Property Name="Client Settings">_WebReports_HTTPServer_HostName=bigfix.test</Property>
    <Property Name="Client Settings">_WebReports_HTTPServer_PortNumber=80</Property>
    <Property Name="Client Settings">_WebReports_HTTPServer_ServerRootPath=/var/opt/BESWebReportsServer/wwwroot</Property>
    <Property Name="Client Settings">_WebReports_HTTPServer_SSLCertificateFilePath=</Property>
    <Property Name="Client Settings">_WebReports_HTTPServer_UseSSLFlag=0</Property>
    <Property Name="Client Settings">_BESClient_DeploymentEncoding_IANAName=windows-1252</Property>
    <Property Name="Computer Name">bigfix.test</Property>
    <Property Name="OS">Linux Red Hat Enterprise Server 7.0 (3.10.0-123.el7.x86_64)</Property>
    <Property Name="CPU">2600 MHz Core i7-3720QM</Property>
    <Property Name="Last Report Time">Wed, 25 May 2016 22:28:02 +0000</Property>
    <Property Name="Locked">No</Property>
    <Property Name="BES Relay Selection Method">Manual</Property>
    <Property Name="Relay">BES Root Server</Property>
    <Property Name="Distance to BES Relay">0</Property>
    <Property Name="BES Relay Service Installed">BES Root Server</Property>
    <Property Name="Relay Name of Client">bigfix.test</Property>
    <Property Name="DNS Name">bigfix.test</Property>
    <Property Name="Active Directory Path">&lt;none&gt;</Property>
    <Property Name="IP Address">10.0.2.15</Property>
    <Property Name="IPv6 Address">fe80:0:0:0:a00:27ff:fe15:a420</Property>
    <Property Name="Subscribed Sites">http://sync.bigfix.com/cgi-bin/bfgather/bessupport</Property>
    <Property Name="BES Root Server">bigfix.test (0)</Property>
    <Property Name="License Type">Non-Windows Server</Property>
    <Property Name="Agent Type">Native</Property>
    <Property Name="Device Type">Server</Property>
    <Property Name="Agent Version">9.2.7.53</Property>
    <Property Name="ID">{id}</Property>
    <Property Name="Computer Type">Physical</Property>
    <Property Name="User Name">&lt;none&gt;</Property>
    <Property Name="RAM">1856 MB</Property>
    <Property Name="Free Space on System Drive">33228 MB</Property>
    <Property Name="Total Size of System Drive">38373 MB</Property>
    <Property Name="BIOS">&lt;n/a&gt;</Property>
    <Property Name="Subnet Address">10.0.2.0</Property>
  </Computer>
</BESAPI>
```

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

### Create Role Configuration

Source: https://github.com/bigfix/developer.bigfix.com/blob/master/site/pages/rest-api/iem_cli/iem_samples.md

Creates a new role configuration by posting an XML file containing the role data to the IEM server.

```bash
./iem post Example.xml roles
```

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

### Registration Task Trigger Type

Source: https://github.com/bigfix/developer.bigfix.com/blob/master/site/pages/relevance/_reference/docs/world.md

Creates a task trigger type corresponding to a registration trigger, which starts a task whenever it gets registered or updated.

```relevance
registration task trigger type : task trigger type
```

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

### Prefetch Example: Downloading an Image

Source: https://github.com/bigfix/developer.bigfix.com/blob/master/site/pages/action-script/reference/download/prefetch.md

Demonstrates how to use the prefetch command to download an image file, specifying its name, SHA-1 and SHA-256 hashes, size, and URL.

```actionscript
prefetch hodor.jpg sha1:ce842e0af799f2ba476511c8fbfdc3bf89612dd0 size:57656 http://i.imgur.com/YAUeUOG.jpg sha256:74f69205a016a3896290eae03627e15e8dfeba812a631b5e0afca140722a322b
```

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

### Create Resource using POST

Source: https://github.com/bigfix/developer.bigfix.com/blob/master/site/pages/rest-api/gettingstarted.md

This snippet demonstrates how to create and trigger an action using an HTTP POST request to the BigFix API. It requires the server URL and an XML payload specifying the Fixlet ID and target computer ID.

```APIDOC
POST https://<bigfix_server>:52311/api/actions

Request Body:
<?xml version="1.0" encoding="UTF-8"?>
<BES xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xsi:noNamespaceSchemaLocation="BES.xsd">
  <SourcedFixletAction>
    <SourceFixlet>
      <Sitename>BES Support</Sitename>
      <FixletID>168</FixletID>
      <Action>Action3</Action>
    </SourceFixlet>
    <Target>
      <ComputerID>{id}</ComputerID>
    </Target>
  </SourcedFixletAction>
</BES>

Response Body:
<?xml version="1.0" encoding="UTF-8"?>
<BESAPI xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xsi:noNamespaceSchemaLocation="BESAPI.xsd">
    <Action Resource="http://{server}:52311/api/action/42" LastModified="Fri, 21 Nov 2014 16:49:04 +0000">
        <Name>BES Client Setting: CPU Usage</Name>
        <ID>42</ID>
    </Action>
</BESAPI>
```

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

### Lock Client Indefinitely

Source: https://github.com/bigfix/developer.bigfix.com/blob/master/site/pages/action-script/reference/client/action-lock-indefinite.md

Locks the BigFix client indefinitely starting from the specified date. The example demonstrates locking the client immediately using the 'now' keyword.

```actionscript
action lock indefinite {now}
```

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

### Fetch Site Content (GET)

Source: https://github.com/bigfix/developer.bigfix.com/blob/master/site/pages/rest-api/api/site.md

Retrieves a list of all content within a specified site. Returns content details in BESAPI.XML format. Example URL provided.

```APIDOC
GET /api/site/{site type}/{site name}/content
  Description: Fetches a list all content within a site.
  Request: URL is all that is required.
  Example Request: https://lab.bigfix.me:52311/api/site/master/content
  Response: BESAPI.XML file.
  Response Schema: BESAPI.xsd
```

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

### Login to IEM Server

Source: https://github.com/bigfix/developer.bigfix.com/blob/master/site/pages/rest-api/iem_cli/iem_samples.md

Logs into the IEM server using provided credentials. This is the initial step for most command-line operations.

```bash
iem login --server=servername:serverport --user=username --password=password
```

```bash
./iem login --server=servername:serverport --user=username --password=password
```

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

### Get Client Version

Source: https://github.com/bigfix/developer.bigfix.com/blob/master/site/pages/relevance/_reference/docs/client.md

Retrieves the product version of the BES application (BESClient or QnA). On Macintosh systems, this returns a string. An example shows how to cast the version to a string.

```relevance
version of <client> : version

Example:
version of client as string - Returns a string like "4.0.3.7".
```

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

### Example cURL Request for Status

Source: https://github.com/bigfix/developer.bigfix.com/blob/master/site/pages/other/explorer-api/status.md

This snippet demonstrates how to call the BigFix Explorer Status API using cURL. It shows the GET request to the /api/status endpoint.

```bash
curl -X GET https://bf-explorer:9383/api/status
```

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

### Create User via SOAP

Source: https://github.com/bigfix/developer.bigfix.com/blob/master/site/pages/other/soap-api/examples/create_user_example.md

This Perl script demonstrates how to create a new user by sending a SOAP request. It includes setting up the SOAP client, defining login credentials, new user information, and handling the response. The script utilizes the SOAP::Lite module.

```perl
use SOAP::Lite;

my $host = "http://localhost/webreports";

# The login credentials for an existing admin user
my $username = 'name';
my $password = 'password';

# The new user information
my $newUserLogin = 'new_admin';
my $newUserFullName = 'Mr. New User';
my $newUserPassword = 'new_password';
my $newUserRole = 'Administrator';

my $service = SOAP::Lite->uri( $host . '?wsdl' )->proxy( $host );
# this string includes embedded quotes by using backslash characters (\")
my $loginXML = "<h:RequestHeaderElement xsi:type=\"LoginHeader\" " \
. " xmlns:h=\"http://schemas.example.com/webreports\n" xmlns:xsi=\"http://www.w3.org/2001/XMLSchema-instance\" " \
. " xmlns=\"http://schemas.example.com/webreports\n" xmlns:xsd=\"http://www.w3.org/2001/XMLSchema">" \
. " <username>$username</username>" \
. " <password>$password</password>" \
. "</h:RequestHeaderElement>";

my $loginHeaders = SOAP::Header->type( 'xml' => $loginXML );

my $newUserInfo = SOAP::Data->name( 'user' => \SOAP::Data->value(
SOAP::Data->name( 'logonName' => $newUserLogin ),
SOAP::Data->name( 'fullName' => $newUserFullName ),
SOAP::Data->name( 'password' => $newUserPassword ),
SOAP::Data->name( 'role' => $newUserRole )
) );

my $result = $service->CreateUser( $newUserInfo, $loginHeaders );
PrintResult( $result, "CreateUserResponse" );

sub PrintResult {
   my $result = shift;
   my $responseName = shift;
   
   if ( $result->fault ) {
      print "faultcode: " . $result->faultcode . "\n";
      print "faultstring: " . $result->faultstring . "\n";
   }
   else {
      print $result->result . "\n";
   foreach my $answer ( $result->valueof( \"//$responseName/a\" ) ) { print $answer . "\n"; }
   }
}

```

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

### Example: Downloading and Executing a Prefetch Plugin

Source: https://github.com/bigfix/developer.bigfix.com/blob/master/site/pages/action-script/reference/download/collect-prefetch-items.md

An example demonstrating the use of 'collect prefetch items' within a 'prefetch block'. It shows how to add a plugin to the prefetch queue, collect it, execute it, and then process additional downloads specified by the plugin.

```actionscript
begin prefetch block
parameter "ini"="{file "server_bf.ini" of site (value of setting "MyCustomSite") of client}"
add prefetch item name=myPlugIn.exe sha1=78ed0f73e7e34e0d0882dd453be0c5ac0f0913eb size=1240 url=http://mysite/plugin.exe
// collect the plug-in before continuing:
collect prefetch items
execute prefetch plug-in "{download path "myPlugIn.exe"}" /downloads "{parameter "ini"}" "{download path "urllist"}"
add prefetch item {concatenation " ; " of lines of download file "urllist"}
end prefetch block
```

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

### Example: Get Firewall Rule Names (Windows)

Source: https://github.com/bigfix/developer.bigfix.com/blob/master/site/pages/relevance/_reference/docs/firewall-rule.md

Demonstrates querying the names of firewall rules on a Windows computer using QnA. Shows the first 3 answers.

```relevance
Q: names of rules of firewall
A: BES Client (ICMPv6)
A: BES Client (ICMPv4)
A:
```

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

### BigFix Computer Resource XML Structure

Source: https://github.com/bigfix/developer.bigfix.com/blob/master/site/pages/rest-api/gettingstarted.md

Example XML structure for a computer resource as returned by the BigFix REST API. It includes the computer's resource URL, last report time, and ID.

```XML
<?xml version="1.0" encoding="UTF-8"?>
<BESAPI xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xsi:noNamespaceSchemaLocation="BESAPI.xsd">
    <Computer Resource="api/computer/2785212">
        <LastReportTime>Fri, 07 Nov 2015 15:18:14 +0000</LastReportTime>
        <ID>2785212</ID>
    </Computer>
...
```

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

### Python Requests SSL Verification

Source: https://github.com/bigfix/developer.bigfix.com/blob/master/site/pages/rest-api/examples/index.md

Demonstrates how to make a GET request using the Python Requests library and disable SSL certificate verification. This is useful when dealing with self-signed certificates.

```python
import requests

response = requests.get('https://bigfix.server:52311/api/help', verify=False)
print(response)
```

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

### Fetch Site Files (GET)

Source: https://github.com/bigfix/developer.bigfix.com/blob/master/site/pages/rest-api/api/site.md

Retrieves a list of all files within a specified site. Returns file details in BESAPI.XML format. Example URL and response XML provided.

```APIDOC
GET /api/site/{site type}/{site name}/files
  Description: Fetches a list all site files.
  Request: URL is all that is required.
  Example Request: https://lab.bigfix.me:52311/api/site/master/files
  Response: BESAPI.XML file.
  Response Schema: BESAPI.xsd
```

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

### Static and Dynamic Downloads

Source: https://github.com/bigfix/developer.bigfix.com/blob/master/site/pages/action-script/guide/index.md

Explains the different methods for downloading necessary data to targets for running actions and successfully executing Fixlets or tasks.

```ActionScript
This section elaborates on the various approaches for transferring data to target systems, which is crucial for the execution of actions, Fixlets, or tasks.
```

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

### Running QnA on Linux

Source: https://github.com/bigfix/developer.bigfix.com/blob/master/site/pages/tools/qna.md

Instructions for executing the QnA utility on Linux systems. It is typically found within the BESClient executable in the installation directory.

```APIDOC
On Linux systems:

The QnA client for Linux and other platforms is available with the BESClient executable in the installation package.
To run the QnA utility on Linux systems, run the executable found in /opt/BESClient/bin/qna.
```

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

### Creating a Custom Computer Group

Source: https://github.com/bigfix/developer.bigfix.com/blob/master/site/pages/relevance/examples/index.md

Demonstrates how to use BigFix Relevance to create a custom computer group. This scenario guides users through the steps to reproduce the functionality in a test environment.

```BigFix Relevance
/*
This is a placeholder for the actual Relevance code to create a custom computer group.
Actual implementation would involve defining criteria for group membership.
Example:
(name of operating system as string contains "Windows") and (version of operating system as string starts with "10.")
*/

// Example: Create a computer group named 'Windows 10 Machines'
create computer group "Windows 10 Machines" whose (name of operating system as string contains "Windows" and version of operating system as string starts with "10.")
```

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

### Querying Computers via BigFix REST API

Source: https://github.com/bigfix/developer.bigfix.com/blob/master/site/pages/rest-api/gettingstarted.md

Retrieves a list of all administered computers using the BigFix REST API. The response is in XML format, detailing each computer's ID and last report time.

```APIDOC
GET: /api/computers
```

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

### Get Relative File Path

Source: https://github.com/bigfix/developer.bigfix.com/blob/master/site/pages/relevance/_reference/docs/folder.md

Constructs a full file path by combining a base folder with a relative file path string. For example, it can resolve 'Safari.app/Contents/MacOS/Safari' within the applications folder.

```relevance
relative file <string> of <folder> : file
```

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

### Get ID of Task Network Settings

Source: https://github.com/bigfix/developer.bigfix.com/blob/master/site/pages/relevance/_reference/docs/task-network-settings.md

Retrieves the unique GUID identifier for a network profile used by the Task Scheduler. This is essential for uniquely referencing specific network configurations.

```relevance
id of <task network settings>
```

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

### Monitor Resource using GET

Source: https://github.com/bigfix/developer.bigfix.com/blob/master/site/pages/rest-api/gettingstarted.md

This snippet shows how to monitor the progress of a previously created action using an HTTP GET request to the BigFix API. It requires the server URL and the action ID.

```APIDOC
GET https://server:52311/api/action/{id}/status

Request Body:
<?xml version="1.0" encoding="UTF-8"?>
<BESAPI xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xsi:noNamespaceSchemaLocation="BESAPI.xsd">
    <ActionResults Resource="http://{server}:52311/api/action/42/status">
        <ActionID>42</ActionID>
        <Status>Open</Status>
        <DateIssued>Fri, 21 Nov 2014 16:49:04 +0000</DateIssued>
    </ActionResults>
</BESAPI>

Response Body:
<?xml version="1.0" encoding="UTF-8"?>
<BESAPI xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xsi:noNamespaceSchemaLocation="BESAPI.xsd">
    <Action Resource="http://{server}:52311/api/action/42/status">
        <ActionID>42</ActionID>
        <Status>Open</Status>
        <DateIssued>Fri, 21 Nov 2014 16:49:04 +0000</DateIssued>
    </Action>
</BESAPI>
```

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

### Example: Get Firewall Rule Service Names (Mac)

Source: https://github.com/bigfix/developer.bigfix.com/blob/master/site/pages/relevance/_reference/docs/firewall-rule.md

Demonstrates querying the service names associated with firewall rules on a Mac computer using QnA. Shows the first 4 answers.

```relevance
Q: service names of rules of firewall
A:
A:
A: Screen Sharing
A: Remote Login - SSH
```

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

### Application Usage Summary

Source: https://github.com/bigfix/developer.bigfix.com/blob/master/site/pages/relevance/_reference/docs/world.md

Provides an application usage summary, including start time, duration, and other client application statistics.

```relevance
Q: application usage summary
A: 
```

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

### Example: Get Firewall Rule Service Names (Windows)

Source: https://github.com/bigfix/developer.bigfix.com/blob/master/site/pages/relevance/_reference/docs/firewall-rule.md

Demonstrates querying the service names associated with firewall rules on a Windows computer using QnA. Shows the first 4 answers.

```relevance
Q: service names of rules of firewall
A:
A:
A: Ssdpsrv
A: Ssdpsrv
```

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

### Site XML Definition

Source: https://github.com/bigfix/developer.bigfix.com/blob/master/site/pages/rest-api/examples/create-site.md

This is an example XML file defining a custom site for BigFix. It includes the site name, gather URL, description, domain, permissions, and subscription criteria based on operating system relevance.

```xml
<BES xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xsi:noNamespaceSchemaLocation="BES.xsd">
        <CustomSite>
                <Name>Test</Name>
                <GatherURL>http://bigfix.test:52311/cgi-bin/bfgather.exe/CustomSite_Test</GatherURL>
                <Description>This is an example Custom Site</Description>
                <Domain>BESC</Domain>
                <GlobalReadPermission>false</GlobalReadPermission>
                <Subscription>
                        <Mode>Custom</Mode>
                        <CustomGroup JoinByIntersection="false">
                                <SearchComponentRelevance Comparison="IsTrue">
                                        <Relevance>name of operating system contains "Win"</Relevance>
                                </SearchComponentRelevance>
                        </CustomGroup>
                </Subscription>
        </CustomSite>
</BES>
```

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

### Previewing BigFix Developer Site with Vagrant

Source: https://github.com/bigfix/developer.bigfix.com/blob/master/README.md

Instructions for previewing local changes to the developer.bigfix.com website. Requires Vagrant and VirtualBox. The site will be available at localhost:4000.

```bash
$ vagrant up

```

```bash
$ vagrant ssh

```

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

### Filtering lists with 'whose' and 'it'

Source: https://github.com/bigfix/developer.bigfix.com/blob/master/site/pages/relevance/guide/basics/it-expressions.md

This example shows how the 'whose' clause, combined with 'it', can filter a list based on a condition applied to each item. Here, it filters files whose names start with 'b'.

```relevance
Q: exist files whose (name of it starts with "b") of folder "c:"
A: True
```

```relevance
Q: number of (files whose (name of it starts with "b") of folder "c:")
A: 2
```

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

### Get Random Delay for Weekly Task Trigger

Source: https://github.com/bigfix/developer.bigfix.com/blob/master/site/pages/relevance/_reference/docs/weekly-task-trigger.md

Returns the random delay time that is added to the scheduled start time of a weekly task trigger. This helps in distributing the load of task executions.

```relevance
random delay of <weekly task trigger> : time interval
```

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

### Get Boot Task Trigger Delay

Source: https://github.com/bigfix/developer.bigfix.com/blob/master/site/pages/relevance/_reference/docs/boot-task-trigger.md

Retrieves the delay time interval associated with a boot task trigger. This inspector is useful for understanding when a boot-time task is scheduled to start relative to the system boot.

```BigFix Relevance
delay of <boot task trigger> : time interval
```

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

### BigFix Site File Management

Source: https://github.com/bigfix/developer.bigfix.com/blob/master/site/pages/rest-api/iem_cli/iem_samples.md

Commands for adding files to different BigFix sites (custom, master action, operator). Includes options for overriding existing files and making them client-downloadable.

```bash
./iem post /tmp/file.my /api/site/custom/test/file/file.my
```

```bash
./iem post /tmp/file.my /api/site/master/file/file.my --force=true
```

```bash
./iem post /tmp/file.my /api/site/operator/nmo/file/file.my --isClientFile=true
```

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

### Sample Compliance Document: Check for Windows OS

Source: https://github.com/bigfix/developer.bigfix.com/blob/master/site/pages/other/cc-api/cc_an_example.md

This XML snippet defines a compliance item to check if the client computer is running a Windows operating system. It uses a relevance expression to test if the operating system name starts with 'Win'.

```xml
<?xml version="1.0"?>
<BESClientComplianceDocument Version="1.0">
	<Date>13 Jun 2004 13:41:57 -0700</Date>
	<ComplianceItem>
		<Designator>IsWindowsOS</Designator>
		<Expression>name of operating system starts with "Win"</Expression>
		<Description>Is a Windows computer</Description>
		<Comment>Compliant if True</Comment>
	</ComplianceItem>
</BESClientComplianceDocument>
```

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

### Download List from File Example

Source: https://github.com/bigfix/developer.bigfix.com/blob/master/site/pages/action-script/reference/download/add-prefetch-item.md

Illustrates how to use the 'add prefetch item' command with relevance substitution to read download items from an external file, with one item per line.

```actionscript
begin prefetch block
add prefetch item {concatenation ";" of lines of file my-downloads.txt}
end prefetch block
```

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

### Execute Prefetch Plugin for Dynamic Downloads

Source: https://github.com/bigfix/developer.bigfix.com/blob/master/site/pages/action-script/guide/dynamic_download.md

This example demonstrates using the `execute prefetch plugin` command to process files and generate a manifest dynamically. A plugin executable is added to the prefetch queue, collected, and then executed with arguments to create a manifest file. Finally, the downloads specified in the generated manifest are queued.

```actionscript
begin prefetch block
   // Adds the plugin to the prefetch queue 
   add prefetch item name=myPlugIn.exe sha1=123 size=456 url=http://mysite/plugin.exe sha2=347
      
   // Collects the plug-in before prefetch processing continues
   collect prefetch items
   parameter "ini"="{file \"prepass.ini\" of site (value of setting \"CustomSite\") of client}"
		 
   // Runs the plug-in with its arguments including the path for the data 
   // file and the manifest to be produced from it.
   execute prefetch plug-in "{download path \"myPlugIn.exe\"}" /downloads "{parameter \"ini\"}" "{download path \"manifest\"}"
		 
   // Queues up the downloads specified in the freshly created manifest	
   add prefetch item {concatenation \" ; \" of lines of download file \"manifest\"}
end prefetch block
```

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

### Compliance Document: Check Windows 7 Service Pack

Source: https://github.com/bigfix/developer.bigfix.com/blob/master/site/pages/other/cc-api/cc_an_example.md

This XML compliance document verifies if a client computer is running Windows 7 with at least Service Pack 2 installed. It utilizes a relevance expression to compare the operating system name and its CSD version.

```xml
<BESClientComplianceDocument Version="1.0">
	<ComplianceItem>
		<Designator>XPServicePack</Designator>
		<Expression>
		name of operating system = "Win7" AND csd version of operating system >= "Service Pack 2"
		</Expression>
		<Description>
		Minimum Windows 7 Service Pack requirement: Service Pack 2
		</Description>
		<Comment>Compliant if True</Comment>
	</ComplianceItem>
</BESClientComplianceDocument>
```

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

### Best Practice: Loading Wizard Files Locally

Source: https://github.com/bigfix/developer.bigfix.com/blob/master/site/pages/tools/presentation_debugger.md

This snippet describes the process of creating a Document Wizard *.ojo* file locally and loading it via the Debug menu for viewing and reloading.

```relevance
Create a Document Wizard *.ojo* file on your local drive, and then select Debug > Load Wizard to load and view it. The file will be reloaded each time you close and reopen the document.
```

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

### Startup Item

Source: https://github.com/bigfix/developer.bigfix.com/blob/master/site/pages/relevance/_reference/docs/world.md

Represents a startup item. No specific documentation available.

```BigFix Relevance
startup item : enableable_file
```