Tanium Deploy

https://help.tanium.com/bundle/ug_deploy_cloud/
Admin
Tanium Deploy is a software management module that enables rapid installation, updating, and removal...
Tokens:28,263
Snippets:487
Trust Score:10
Update:6 months ago
Show doc for...
Tokens:
Raw
### Example Response for Deploy Packages

Source: https://help.tanium.com/bundle/ug_deploy_cloud/page/deploy/deploy_gateway_examples.html

This is an example of the JSON response when querying for all Deploy packages, showing details for several software titles.

```json
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
{
  "data": {
    "softwarePackages": {
      "edges": [
        {
          "node": {
            "id": "19",
            "productName": "Firefox (x64 en-US)",
            "productVendor": "Mozilla",
            "productVersion": "98.0"
          }
        },
        {
          "node": {
            "id": "30",
            "productName": "Power BI Desktop (x64)",
            "productVendor": "Microsoft",
            "productVersion": "2.102.845.0"
          }
        },
        {
          "node": {
            "id": "43",
            "productName": "VLC media player (64-bit)",
            "productVendor": "VideoLAN",
            "productVersion": "3.0.16.0"
          }
        },
        {
          "node": {
            "id": "46",
            "productName": "Visual Studio Code (x64 en-us)",
            "productVendor": "Microsoft",
            "productVersion": "1.65.2"
          }
        }
      ]
    }
  }
}
```

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

### Example Response for Software Deployment Status

Source: https://help.tanium.com/bundle/ug_deploy_cloud/page/deploy/deploy_gateway_examples.html

An example JSON response detailing the status of software deployments, including counts for various stages and error information.

```json
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
{
  "data": {
    "softwareDeployment": [
      {
        "ID": "5",
        "name": "Install Tanium Standard Utilities",
        "status": {
          "completeCount": 1,
          "downloadCompleteWaitingCount": 0,
          "downloadingCount": 0,
          "failedCount": 0,
          "notApplicableCount": 0,
          "runningCount": 0,
          "waitingCount": 0
        },
        "errors": null
      },
      {
        "ID": "6",
        "name": "Install Tanium Standard Utilities (Linux)",
        "status": {
          "completeCount": 0,
          "downloadCompleteWaitingCount": 0,
          "downloadingCount": 1,
          "failedCount": 0,
          "notApplicableCount": 0,
          "runningCount": 0,
          "waitingCount": 0
        },
        "errors": null
      }
    ]
  }
}
```

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

### Example Package Query Response

Source: https://help.tanium.com/bundle/ug_deploy_cloud/page/deploy/deploy_gateway_examples.html

This is an example JSON response for the package details query. It shows the structure and typical values for package information, including content set and metadata.

```json
{
  "data": {
    "packages": {
      "items": [
        {
          "id": "1",
          "name": "Distribute Tanium Standard Utilities",
          "displayName": "Distribute Tanium Standard Utilities",
          "command": "cmd.exe /c cscript.exe //E:VBScript install-standard-utils.vbs \"Tools\StdUtils\"",
          "commandTimeout": 2700,
          "expireSeconds": 3300,
          "contentSet": {
            "id": "5",
            "name": "Client Management"
          },
          "processGroupFlag": true,
          "skipLockFlag": false,
          "metadata": [],
          "sourceHash": "60b3e906f92929da67341792db9675d5cd91686546f01b57857686c8c6d84fa8",
          "sourceHashChangedFlag": false,
          "sourceID": 0,
          "sourceName": "",
          "parameters": [],
          "rawParameterDefinition": null,
          "parameterDefinition": null,
          "verifyExpireSeconds": 600
        },
        {
          "id": "2",
          "name": "Distribute Tanium Standard Utilities (Linux)",
          "displayName": "Distribute Tanium Standard Utilities (Linux)",
          "command": "/bin/bash distribute-tools.sh STRICT",
          "commandTimeout": 120,
          "expireSeconds": 720,
          "contentSet": {
            "id": "5",
            "name": "Client Management"
          },
          "processGroupFlag": true,
          "skipLockFlag": false,
          "metadata": [],
          "sourceHash": "4ed7a30a1ca6c81be5a71b892dfadcdb489122cc641fa4b644f53255134215c9",
          "sourceHashChangedFlag": false,
          "sourceID": 0,
          "sourceName": "",
          "parameters": [],
          "rawParameterDefinition": null,
          "parameterDefinition": null,
          "verifyExpireSeconds": 600
        }
      ]
    }
  }
}
```

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

### Customize Windows Setup Command-Line Arguments

Source: https://help.tanium.com/bundle/ug_deploy_cloud/page/deploy/use_case_managing_windows_upgrades.html

Append custom arguments to the PowerShell execution command for the Phase 3 upgrade package to modify Windows Setup behavior.

```powershell
powershell.exe -executionpolicy remotesigned -noninteractive -command ".\New-WindowsUpgradeScheduledTask.ps1" /EULA accept /Bitlocker ForceKeepActive
```

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

### POST /graphql (Get all deploy packages)

Source: https://help.tanium.com/bundle/ug_deploy_cloud/page/deploy/deploy_gateway_examples.html

Retrieves a list of all available software packages including their ID, product name, vendor, and version.

```APIDOC
## POST /graphql

### Description
Retrieves all Deploy packages available in the system.

### Method
POST

### Endpoint
/graphql

### Request Body
- **query** (string) - Required - GraphQL query: `query exampleGetDeployPackages { softwarePackages { edges { node { id productName productVendor productVersion } } } }`

### Response
#### Success Response (200)
- **data** (object) - Contains the list of software packages.

#### Response Example
{
  "data": {
    "softwarePackages": {
      "edges": [
        {
          "node": {
            "id": "19",
            "productName": "Firefox (x64 en-US)",
            "productVendor": "Mozilla",
            "productVersion": "98.0"
          }
        }
      ]
    }
  }
}
```

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

### POST /graphql (Get all packages)

Source: https://help.tanium.com/bundle/ug_deploy_cloud/page/deploy/deploy_gateway_examples.html

Retrieves a list of all packages with their associated metadata, commands, and parameter definitions.

```APIDOC
## POST /graphql

### Description
Retrieves details for all packages. Note: This is considered legacy in favor of query.packageSpec.

### Method
POST

### Endpoint
/graphql

### Request Body
```graphql
query examplePackagesQuery {
  packages {
    items {
      id
      name
      displayName
      command
      commandTimeout
      expireSeconds
      contentSet {
        id
        name
      }
      processGroupFlag
      skipLockFlag
      metadata {
        adminFlag
        name
        value
      }
      sourceHash
      sourceHashChangedFlag
      sourceID
      sourceName
      parameters {
        key
        value
      }
      rawParameterDefinition
      parameterDefinition {
        parameterType
        model
        parameters {
          model
          parameterType
          key
          label
          helpString
          defaultValue
          validationExpressions {
            model
            parameterType
            expression
            helpString
          }
          promptText
          heightInLines
          maxChars
          values
          restrict
          allowEmptyList
          minimum
          maximum
          stepSize
          snapInterval
          dropdownOptions {
            model
            parameterType
            name
            value
          }
          componentType
          startDateRestriction {
            model
            parameterType
            type
            interval
            intervalCount
            unixTimeStamp
          }
          endDateRestriction {
            model
            parameterType
            type
            interval
            intervalCount
            unixTimeStamp
          }
          startTimeRestriction {
            model
            parameterType
            type
            interval
            intervalCount
            unixTimeStamp
          }
          endTimeRestriction {
            model
            parameterType
            type
            interval
            intervalCount
            unixTimeStamp
          }
          allowDisableEnd
          defaultRangeStart {
            model
            parameterType
            type
            interval
            intervalCount
            unixTimeStamp
          }
          defaultRangeEnd {
            model
            parameterType
            type
            interval
            intervalCount
            unixTimeStamp
          }
          separatorText
        }
      }
      verifyExpireSeconds
    }
  }
}
```

### Response
#### Success Response (200)
- **data** (object) - The root object containing the packages list.

#### Response Example
```json
{
  "data": {
    "packages": {
      "items": [
        {
          "id": "1",
          "name": "Distribute Tanium Standard Utilities",
          "displayName": "Distribute Tanium Standard Utilities",
          "command": "cmd.exe /c cscript.exe //E:VBScript install-standard-utils.vbs \"Tools\\StdUtils\"",
          "commandTimeout": 2700,
          "expireSeconds": 3300,
          "contentSet": {
            "id": "5",
            "name": "Client Management"
          },
          "processGroupFlag": true,
          "skipLockFlag": false,
          "metadata": [],
          "sourceHash": "60b3e906f92929da67341792db9675d5cd91686546f01b57857686c8c6d84fa8",
          "sourceHashChangedFlag": false,
          "sourceID": 0,
          "sourceName": "",
          "parameters": [],
          "rawParameterDefinition": null,
          "parameterDefinition": null,
          "verifyExpireSeconds": 600
        }
      ]
    }
  }
}
```
```

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

### POST /graphql (Get software deployment status)

Source: https://help.tanium.com/bundle/ug_deploy_cloud/page/deploy/deploy_gateway_examples.html

Retrieves the current deployment status and error counts for software packages.

```APIDOC
## POST /graphql

### Description
Retrieves the deployment status of all Deploy packages, including counts for various states like complete, downloading, and failed.

### Method
POST

### Endpoint
/graphql

### Request Body
- **query** (string) - Required - GraphQL query: `query exampleGetSoftwareDeploymentStatus { softwareDeployment { ID name status { completeCount downloadCompleteWaitingCount downloadingCount failedCount notApplicableCount runningCount waitingCount } errors { error count } } }`

### Response
#### Success Response (200)
- **data** (object) - Contains the software deployment status list.

#### Response Example
{
  "data": {
    "softwareDeployment": [
      {
        "ID": "5",
        "name": "Install Tanium Standard Utilities",
        "status": {
          "completeCount": 1,
          "downloadCompleteWaitingCount": 0,
          "downloadingCount": 0,
          "failedCount": 0,
          "notApplicableCount": 0,
          "runningCount": 0,
          "waitingCount": 0
        },
        "errors": null
      }
    ]
  }
}
```

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

### Recombine split installer files

Source: https://help.tanium.com/bundle/ug_deploy_cloud/page/deploy/managing_software.html

Use these commands within software package operations to recombine split archive parts after uploading them to the package.

```Windows
copy /B installer.z* installer.zip
```

```Linux
cat installer.z* > installer.zip
```
Tokens:
Raw