Important

   

This space contains documentation for TrueSight Server Automation 8.9.03 and the later service packs for 8.9. For earlier releases, see BMC Server Automation 8.9.

REST API endpoints

TrueSight Server Automation REST API – Version 1

The base URL for the API is:

https://appserver:port/rest

bl-packages NEW IN 8.9.04.003

APIs for retrieving blpackages

GET /api/v1/blpackages
Parameters

Name

Located in

Description

Default

Schema

id

query

Filter for the blpackage ID based on which the search must be run.


integer

name

query

Specifies the blpackage name whose details you want to retrieve.


string

page

query

Returns the specified page number of the results. The value starts at 0. By default, all the results are displayed on one page.


integer

size

query

The number of items to be displayed on one page.


integer

Responses

Code

Description

Schema

200

OK

#BLPackages

401

Unauthorized


403

Forbidden


404

Not Found


catalogs

APIs for creating, retrieving, updating, or executing patch catalogs

GET /api/v1/catalogs
 Retrieves the list of all patch catalogs created for all the operating systems.


Parameters

Name

Located in

Description

Default

Schema

page

query

Returns the specified page number of the results. The value starts at 0. By default, all the results are displayed on one page.


integer

size

query

The number of items to be displayed on one page.


integer

type

query

Filter for the type of the operating system whose patch catalogs you want to retrieve.


string
Enum: [
  "windows",
  "redhat"
]

Responses

Code

Description

Schema

200

OK

#List Of Catalogs

401

Unauthorized


403

Forbidden


404

Not Found


PATCH /api/v1/catalogs/{id}
 Updates the specific patch catalog.


Parameters

Name

Located in

Description

Default

Schema

id

path

Specifies the catalog ID to be updated.


integer*

notification_url

body

Specifies the notification URL parameters to be provided as a callback.


#Notification URL

Responses

Code

Description

Schema

200

OK

#Schedule ID

204

No Content


401

Unauthorized


403

Forbidden


GET /api/v1/catalogs/{id}/containers
 Retrieves the list of all patch containers in a specific catalog.


Parameters

Name

Located in

Description

Default

Schema

bulletin_id

query

(Applicable for Windows operating system) The bulletin ID of the patch based on which the search must be run.


string

cve_id

query

The Common Vulnerabilities and Exposures Identifier based on which the search must be run.


string

errata_advisory

query

The errata advisory whose details you want to retrieve.


string

errata_type

query

Type of the errata whose details you want to retrieve.


string

iava_id

query

(Applicable for Windows operating system) Information assurance vulnerability alert ID.


string

id

path

Specifies the catalog ID whose details you want to retrieve.


integer*

name

query

Name of the container whose details you want to retrieve. The search is case-insensitive.


string

obsolete

query

(Applicable for Windows operating system) The vendor-defined impact definition of the patch based on which the search must be run.


boolean

page

query

Returns the specified page number of the results. The value starts at 0. By default, all the results are displayed on one page.


integer

patch_type

query

(Applicable for Windows operating system) Type of the patch based on which the search must be run.


string
Enum: [
  "microsoft_security_patch",
  "non_mircosoft_security_patch",
  "software_distribution",
  "security_tools",
  "non_security_patch"
]

q_number

query

(Applicable for Windows operating system) The Q number of the patch based on which the search must be run.


string

size

query

The number of items to be displayed on one page.


integer

vendor_impact

query

(Applicable for Windows operating system) Vendor definition of Impact.


string
Enum: [
  "Unknown",
  "Critical",
  "Important",
  "Low",
  "Moderate"
]

Responses

Code

Description

Schema

200

OK

#Patch Containers

401

Unauthorized


403

Forbidden


404

Not Found


GET /api/v1/catalogs/{id}/jobruns
 Retrieves the list of all job runs for a specified catalog ID.


Parameters

Name

Located in

Description

Default

Schema

id

path

Specifies the catalog ID whose runs you want to retrieve across the latest version.


integer*

page

query

Returns the specified page number of the results. The value starts at 0. By default, all the results are displayed on one page.


integer

size

query

The number of items to be displayed on one page.


integer

Responses

Code

Description

Schema

200

OK

#TSSA Job Runs list

401

Unauthorized


403

Forbidden


404

Not Found


GET /api/v1/catalogs/{id}/jobruns/{run_id}
 Retrieves the catalog job run details for the specific catalog ID and the associated job run ID.


Parameters

Name

Located in

Description

Default

Schema

id

path

Specifies the catalog ID whose details you want to retrieve.


integer*

run_id

path

Specifies the catalog job run ID whose details you want to retrieve.


integer*

Responses

Code

Description

Schema

200

OK

#Job Run Details

401

Unauthorized


403

Forbidden


404

Not Found


GET /api/v1/catalogs/{id}/jobruns/{run_id}/events
 Retrieves the list of all catalog job run event details for the specific catalog ID and the associated job run ID.


Parameters

Name

Located in

Description

Default

Schema

event_type

query

Type of the event whose details you want to retrieve. The search is case-insensitive.


string
Enum: [
  "info",
  "error",
  "warning",
  "fine",
  "finer",
  "finest"
]

id

path

Specifies the catalog ID whose details you want to retrieve.


integer*

page

query

Returns the specified page number of the results. The value starts at 0. By default, all the results are displayed on one page.


integer

run_id

path

Specifies the catalog job run ID whose details you want to retrieve.


integer*

size

query

The number of items to be displayed on one page.


integer

Responses

Code

Description

Schema

200

OK

#Job Run Events

401

Unauthorized


403

Forbidden


404

Not Found


GET /api/v1/catalogs/{id}/patches
 Retrieves the list of all patches in catalogs. Incompatible filters will be ignored.


Parameters

Name

Located in

Description

Default

Schema

bulletin_id

query

(Applicable for Windows operating system) The bulletin ID of the patch based on which the search must be run.


string

cve_id

query

(Applicable for Windows operating system) Common Vulnerabilities and Exposures Identifier.


string

id

path

Specifies the catalog ID whose details you want to retrieve.


integer*

is_reboot_required

query

(Applicable for Windows operating system) Specifies whether the patch requires reboot.


boolean

name

query

Name of the patch.


string

page

query

Returns the specified page number of the results. The value starts at 0. By default, all the results are displayed on one page.


integer

patch_impact

query

(Applicable for Windows operating system) Patch Impact - Vendor defined impact definition of the patch.


string
Enum: [
  "Unknown",
  "Critical",
  "Important",
  "Low",
  "Moderate"
]

patch_name

query

(Applicable for Windows operating system) Patch Name - Vendor defined name of patch binary.


string

patch_type

query

(Applicable for Windows operating system) Patch Type.


string
Enum: [
  "microsoft_security_patch",
  "non_mircosoft_security_patch",
  "software_distribution",
  "security_tools",
  "non_security_patch"
]

q_number

query

(Applicable for Windows operating system) The Q number of the patch based on which the search must be run.


string

size

query

The number of items to be displayed on one page.


integer

Responses

Code

Description

Schema

200

OK

#List Of Patches

401

Unauthorized


403

Forbidden


404

Not Found


PUT /api/v1/catalogs/{id}/schedules
 Updates patch catalog schedules for a specific catalog ID.


Parameters

Name

Located in

Description

Default

Schema

catalog_schedule_request

body

Catalog Schedule request body.


#Update Schedule Request

id

path

Specifies the catalog ID for which the schedule needs to be updated.


integer*

Responses

Code

Description

Schema

200

OK


201

Created


401

Unauthorized


403

Forbidden


404

Not Found



configs

APIs for TrueSight Server Automation configuration

GET /api/v1/configs/timezones
 Retrieves the list of all the supported timezones.


Responses

Code

Description

Schema

200

OK

[
   #Available timezone
]

401

Unauthorized


403

Forbidden


404

Not Found



deploy-jobs NEW IN 8.9.04.003

APIs for retrieving, creating, executing, or deleting deploy jobs

POST /api/v1/deploy-jobs
 Creates a deploy job for the specified request.


Parameters

Name

Located in

Description

Default

Schema

Deploy job request

body

Specifies the request definition of basic or advanced deploy jobs.


#Deploy Job request

Responses

Code

Description

Schema

200

OK

#Deploy Job Response

201

Created


401

Unauthorized


403

Forbidden


404

Not Found


DELETE /api/v1/deploy-jobs/{id}
 Deletes a deploy job.


Parameters

Name

Located in

Description

Default

Schema

id

path

Specifies the job ID which you want to delete.


integer*

Responses

Code

Description

Schema

200

OK

boolean

204

No Content


401

Unauthorized


403

Forbidden


PATCH /api/v1/deploy-jobs/{id}
 Executes deploy jobs for a specific job ID.


Parameters

Name

Located in

Description

Default

Schema

id

path

Specifies the job ID whose details you want to retrieve.


integer*

notification_url

body

Specifies the notification URL parameters to be provided as a callback.


#Notification URL

Responses

Code

Description

Schema

200

OK

#Schedule ID

204

No Content


401

Unauthorized


403

Forbidden


GET /api/v1/deploy-jobs/{id}/jobruns
 Retrieves the list of all deploy job runs for a specified job ID.


Parameters

Name

Located in

Description

Default

Schema

id

path

Specifies the job ID whose details you want to retrieve.


integer*

page

query

Returns the specified page number of the results. The value starts at 0. By default, all the results are displayed on one page.


integer

size

query

The number of items to be displayed on one page.


integer

Responses

Code

Description

Schema

200

OK

#Deploy Job Runs list

401

Unauthorized


403

Forbidden


404

Not Found


GET /api/v1/deploy-jobs/{id}/jobruns/{run_id}
 Retrieves the deploy job run details with all its child job runs for the specific job ID and the associated job run ID.


Parameters

Name

Located in

Description

Default

Schema

id

path

Specifies the job ID whose details you want to retrieve.


integer*

run_id

path

Specifies the job run ID whose details you want to retrieve.


integer*

Responses

Code

Description

Schema

200

OK

#Child Deploy Job Runs list

401

Unauthorized


403

Forbidden


404

Not Found


GET /api/v1/deploy-jobs/{id}/jobruns/{run_id}/events
 Retrieves the list of all deploy job run event details with all its child job runs for the specific job ID and the associated job run ID.


Parameters

Name

Located in

Description

Default

Schema

event_type

query

Type of the event whose details you want to retrieve. The search is case-insensitive.


string
Enum: [
  "info",
  "error",
  "warning",
  "fine",
  "finer",
  "finest"
]

id

path

Specifies the job ID whose details you want to retrieve.


integer*

page

query

Returns the specified page number of the results. The value starts at 0. By default, all the results are displayed on one page.


integer

run_id

path

Specifies the job run ID whose details you want to retrieve.


integer*

server_id

query

Specifies the server ID whose details you want to retrieve. If both server_name and server_id are given then server_id will get preference.


integer

server_name

query

Specifies the server name whose details you want to retrieve. The search is case-insensitive. If both server_name and server_id are given then server_id will get preference.


string

size

query

The number of items to be displayed on one page.


integer

type

query

Object type of the event whose details you want to retrieve.The search is case-insensitive.


string
Enum: [
  "deploy_job",
  "simulate",
  "stage",
  "commit"
]

Responses

Code

Description

Schema

200

OK

#Job Run Events

401

Unauthorized


403

Forbidden


404

Not Found


GET /api/v1/deploy-jobs/{id}/jobruns/{run_id}/results
 Retrieves the deploy job results for the specific job ID and the associated job run ID.


Parameters

Name

Located in

Description

Default

Schema

has_errors

query

Specifies whether to retrieve job run results for which the has_error flag is set.


boolean

has_reboot

query

Specifies whether to retrieve job run results for which the has_reboot flag is set.


boolean

has_warnings

query

Specifies whether to retrieve job run results for which the has_warning flag is set.


boolean

id

path

Specifies the job ID whose details you want to retrieve.


integer*

job_type

query

Specify type of deploy job on which results should be filtered.


string
Enum: [
  "deploy_job",
  "simulate",
  "stage",
  "commit"
]

page

query

Returns the specified page number of the results. The value starts at 0. By default, all the results are displayed on one page.


integer

run_id

path

Specifies the job run ID whose details you want to retrieve.


integer*

server_name

query

Specifies the server name whose details you want to retrieve. The search is case-insensitive.


string

size

query

The number of items to be displayed on one page.


integer

Responses

Code

Description

Schema

200

OK

#Deploy job results

401

Unauthorized


403

Forbidden


404

Not Found


groups

APIs for creating, updating, deleting, or retrieving details of static groups

PUT /api/v1/groups/{id}
 Update a group with a specified group ID.


Parameters

Name

Located in

Description

Default

Schema

group

body

Specifies the group name, parent group ID, and the description for the new group.


#Group Request

id

path

Specifies the group ID.


integer*

Responses

Code

Description

Schema

200

OK

#Group Details

201

Created


401

Unauthorized


403

Forbidden


404

Not Found



GET /api/v1/groups/{type}
 Retrieves the list of all groups for a specified type.


Parameters

Name

Located in

Description

Default

Schema

id

query

The ID of the group whose details you want to retrieve. If both Id and path filters are provided, Id will be given preference.


integer

name

query

The name of the group whose details you want to retrieve.


string

page

query

Returns the specified page number of the results. The value starts at 0. By default, all the results are displayed on one page.


integer

path

query

The absolute path of the group whose details you want to retrieve. If both Id and path filters are provided, Id will be given preference.


string

size

query

The number of items to be displayed on one page.


integer

type

path

Filter for the type of the group whose details you want to retrieve. The default value is Server.


string*
Enum: [
  "server",
  "job",
  "depot",
  "component",
  "component_template"
]

Responses

Code

Description

Schema

200

OK

#Group List

401

Unauthorized


403

Forbidden


404

Not Found


POST /api/v1/groups/{type}
 Creates a group with a specified type.


Parameters

Name

Located in

Description

Default

Schema

group

body

Specifies the group name, parent group ID, and the description for the new group.


#Group Request

type

path

Specifies the type of group to be created.


string*
Enum: [
  "server",
  "job",
  "depot",
  "component",
  "component_template"
]

Responses

Code

Description

Schema

200

OK

#Group Details

201

Created


401

Unauthorized


403

Forbidden


404

Not Found



GET /api/v1/groups/{type}/{id}/members
 Retrieves the list of all members of group for a specified type and ID.


Parameters

Name

Located in

Description

Default

Schema

id

path

Specifies the group ID whose members you want to retrieve.


integer*

page

query

Returns the specified page number of the results. The value starts at 0. By default, all the results are displayed on one page.


integer

size

query

The number of items to be displayed on one page.


integer

type

path

Filter for the type of the group whose details you want to retrieve. The default value is Server.


string*
Enum: [
  "server",
  "job",
  "depot",
  "component",
  "component_template"
]

Responses

Code

Description

Schema

200

OK

#Static group children

401

Unauthorized


403

Forbidden


404

Not Found


nsh-script-jobs NEW IN 8.9.04.003

APIs for retrieving, creating, executing, or deleting nsh script jobs

POST /api/v1/nshscript-jobs
 Creates nsh script job for a specified request.


Parameters

Name

Located in

Description

Default

Schema

nshscript_job_create_request

body

Specifies the details for the new nsh script job.


#NSHScript Job Request

Responses

Code

Description

Schema

200

OK

#NSH Script Job Response

201

Created


401

Unauthorized


403

Forbidden


404

Not Found


DELETE /api/v1/nshscript-jobs/{id}
 Deletes nsh script job.


Parameters

Name

Located in

Description

Default

Schema

id

path

Specifies the job ID which you want to delete.


integer*

Responses

Code

Description

Schema

200

OK

boolean

204

No Content


401

Unauthorized


403

Forbidden


PATCH /api/v1/nshscript-jobs/{id}
 Executes nsh script job for a specific job ID.


Parameters

Name

Located in

Description

Default

Schema

id

path

Specifies the job ID whose details you want to retrieve.


integer*

notification_url

body

Specifies the notification URL parameters to be provided as a callback.


#Notification URL

Responses

Code

Description

Schema

200

OK

#Schedule ID

204

No Content


401

Unauthorized


403

Forbidden


GET /api/v1/nshscript-jobs/{id}/jobruns
 Retrieves the list of all job runs for a specified nsh script job ID.


Parameters

Name

Located in

Description

Default

Schema

id

path

Specifies the job ID whose details you want to retrieve.


integer*

job_run_id

query

Specifies the job run ID whose details you want to retrieve.


integer

page

query

Returns the specified page number of the results. The value starts at 0. By default, all the results are displayed on one page.


integer

size

query

The number of items to be displayed on one page.


integer

Responses

Code

Description

Schema

200

OK

#TSSA Job Runs list

401

Unauthorized


403

Forbidden


404

Not Found


GET /api/v1/nshscript-jobs/{id}/jobruns/{run_id}
 Retrieves the nsh script job run details for the specific job ID and the associated job run ID.


Parameters

Name

Located in

Description

Default

Schema

id

path

Specifies the job ID whose details you want to retrieve.


integer*

run_id

path

Specifies the job run ID whose details you want to retrieve.


integer*

Responses

Code

Description

Schema

200

OK

#Job Run Details

401

Unauthorized


403

Forbidden


404

Not Found


GET /api/v1/nshscript-jobs/{id}/jobruns/{run_id}/events
 Retrieves the list of all nsh script job run event details for the specific job ID and the associated job run ID.


Parameters

Name

Located in

Description

Default

Schema

event_type

query

Type of the event whose details you want to retrieve. The search is case-insensitive.


string
Enum: [
  "info",
  "error",
  "warning",
  "fine",
  "finer",
  "finest"
]

id

path

Specifies the job ID whose details you want to retrieve.


integer*

page

query

Returns the specified page number of the results. The value starts at 0. By default, all the results are displayed on one page.


integer

run_id

path

Specifies the job run ID whose details you want to retrieve.


integer*

server_id

query

Specifies the server ID whose details you want to retrieve. If both server_name and server_id are given then server_id will get preference.


integer

server_name

query

Specifies the server name whose details you want to retrieve. The search is case-insensitive. If both server_name and server_id are given then server_id will get preference.


string

size

query

The number of items to be displayed on one page.


integer

Responses

Code

Description

Schema

200

OK

#Job Run Events

401

Unauthorized


403

Forbidden


404

Not Found


GET /api/v1/nshscript-jobs/{id}/jobruns/{run_id}/results
 Retrieves the nsh script job results for the specific job ID and the associated job run ID.


Parameters

Name

Located in

Description

Default

Schema

has_errors

query

Specifies whether to retrieve job run results for which the has_error flag is set.


boolean

has_reboot

query

Specifies whether to retrieve job run results for which the has_reboot flag is set.


boolean

has_warnings

query

Specifies whether to retrieve job run results for which the has_warning flag is set.


boolean

id

path

Specifies the job ID whose details you want to retrieve.


integer*

page

query

Returns the specified page number of the results. The value starts at 0. By default, all the results are displayed on one page.


integer

run_id

path

Specifies the job run ID whose details you want to retrieve.


integer*

server_name

query

Specifies the server name whose details you want to retrieve. The search is case-insensitive.


string

size

query

The number of items to be displayed on one page.


integer

Responses

Code

Description

Schema

200

OK

#TSSA Job Results Device list

401

Unauthorized


403

Forbidden


404

Not Found



nsh-scripts NEW IN 8.9.04.003

APIs for retrieving nsh scripts

GET /api/v1/nshscripts
 Retrieves the list of all nsh scripts.


Parameters

Name

Located in

Description

Default

Schema

id

query

Filter for the nsh script ID based on which the search must be run.


integer

name

query

Specifies the nsh script name whose details you want to retrieve.


string

page

query

Returns the specified page number of the results. The value starts at 0. By default, all the results are displayed on one page.


integer

size

query

The number of items to be displayed on one page.


integer

Responses

Code

Description

Schema

200

OK

#TSSA NSH script list

401

Unauthorized


403

Forbidden


404

Not Found


GET /api/v1/nshscripts/{id}


Parameters

Name

Located in

Description

Default

Schema

id

path

Specifies the nsh script ID whose details you want to retrieve.


integer*

Responses

Code

Description

Schema

200

OK

#NSH Script Parameter Details

401

Unauthorized


403

Forbidden


404

Not Found


patching-jobs

APIs for retrieving, creating, updating, executing or deleting patching jobs

GET /api/v1/patching-jobs
 Retrieves the details of all patching jobs, matching any filter criteria.


Parameters

Name

Located in

Description

Default

Schema

catalog_id

query

Filter for the catalog ID based on which the search must be run.


integer

from_date_created

query

Filter for patching jobs created after this date.


string

from_date_modified

query

Filter for patching jobs modified after this date.


string

name

query

Filter for the patching job name based on which the search must be run.


string

page

query

Returns the specified page number of the results. The value starts at 0. By default, all the results are displayed on one page.


integer

size

query

The number of items to be displayed on one page.


integer

to_date_created

query

Filter for patching jobs created before this date.


string

to_date_modified

query

Filter for patching jobs modified before this date.


string

type

query

Filter for object type of the patching job.


string
Enum: [
  "windows",
  "redhat"
]

Responses

Code

Description

Schema

200

OK

#List Of Patching Jobs

401

Unauthorized


403

Forbidden


404

Not Found



POST /api/v1/patching-jobs
 Creates a patching job for a specified request.


Parameters

Name

Located in

Description

Default

Schema

patching_job_create_request

body

Specifies the details for the new patching job.


#Patching Job Create Request

Responses

Code

Description

Schema

200

OK

#Patching Job Response

201

Created


401

Unauthorized


403

Forbidden


404

Not Found


GET /api/v1/patching-jobs/{id}
 Retrieves the patching job details for a specific job ID.


Parameters

Name

Located in

Description

Default

Schema

id

path

Specifies the job ID whose details you want to retrieve.


integer*

Responses

Code

Description

Schema

200

OK

#Patching Job Response

401

Unauthorized


403

Forbidden


404

Not Found


PUT /api/v1/patching-jobs/{id}
 Updates a specific patching job.


Parameters

Name

Located in

Description

Default

Schema

id

path

The ID of the job whose details you want to update.


integer*

patching_job_update_request

body

Patching job update request body.


#Patching Job Request

Responses

Code

Description

Schema

200

OK


201

Created


401

Unauthorized


403

Forbidden


404

Not Found


DELETE /api/v1/patching-jobs/{id}
 Delete a patching job.


Parameters

Name

Located in

Description

Default

Schema

id

path

Specifies the job ID which you want to delete.


integer*

Responses

Code

Description

Schema

200

OK

boolean

204

No Content


401

Unauthorized


403

Forbidden


PATCH /api/v1/patching-jobs/{id}
 Executes patching job for a specific job ID.


Parameters

Name

Located in

Description

Default

Schema

id

path

Specifies the patching job ID to be executed.


integer*

notification_url

body

Specifies the notification URL parameters to be provided as a callback.


#Notification URL

Responses

Code

Description

Schema

200

OK

#Schedule ID

204

No Content


401

Unauthorized


403

Forbidden


GET /api/v1/patching-jobs/{id}/jobruns
 Retrieves the list of all job runs for a specified patching job ID.


Parameters

Name

Located in

Description

Default

Schema

id

path

Specifies the job ID whose details you want to retrieve.


integer*

page

query

Returns the specified page number of the results. The value starts at 0. By default, all the results are displayed on one page.


integer

size

query

The number of items to be displayed on one page.


integer

Responses

Code

Description

Schema

200

OK

#TSSA Job Runs list

401

Unauthorized


403

Forbidden


404

Not Found


GET /api/v1/patching-jobs/{id}/jobruns/{run_id}
 Retrieves the patching job run details with all its child job runs for the specific job ID and the associated job run ID.


Parameters

Name

Located in

Description

Default

Schema

id

path

Specifies the job ID whose details you want to retrieve.


integer*

run_id

path

Specifies the job run ID whose details you want to retrieve.


integer*

Responses

Code

Description

Schema

200

OK

#Patching Job Runs

401

Unauthorized


403

Forbidden


404

Not Found


GET /api/v1/patching-jobs/{id}/jobruns/{run_id}/events
 Retrieves the list of all patching job run event details with all its child job runs for the specific job ID and the associated job run ID.


Parameters

Name

Located in

Description

Default

Schema

event_type

query

Type of the event whose details you want to retrieve. The search is case-insensitive.


string
Enum: [
  "info",
  "error",
  "warning",
  "fine",
  "finer",
  "finest"
]

id

path

Specifies the job ID whose details you want to retrieve.


integer*

page

query

Returns the specified page number of the results. The value starts at 0. By default, all the results are displayed on one page.


integer

run_id

path

Specifies the job run ID whose details you want to retrieve.


integer*

server_id

query

Specifies the server ID whose details you want to retrieve. If both server_name and server_id are given then server_id will get preference.


integer

server_name

query

Specifies the server name whose details you want to retrieve. The search is case-insensitive. If both server_name and server_id are given then server_id will get preference.


string

size

query

The number of items to be displayed on one page.


integer

type

query

Object type of the event whose details you want to retrieve.The search is case-insensitive.


string
Enum: [
  "analysis",
  "remediation",
  "download",
  "deploy_job",
  "simulate",
  "stage",
  "commit"
]

Responses

Code

Description

Schema

200

OK

#Job Run Events

401

Unauthorized


403

Forbidden


404

Not Found


GET /api/v1/patching-jobs/{id}/jobruns/{run_id}/results
 Retrieves the patching Job result details with its child job runs for the specific job ID and the associated job run ID.


Parameters

Name

Located in

Description

Default

Schema

id

path

Specifies the job ID whose details you want to retrieve.


integer*

run_id

path

Specifies the job run ID whose details you want to retrieve.


integer*

Responses

Code

Description

Schema

200

OK

#Patching job result summary

401

Unauthorized


403

Forbidden


404

Not Found


GET /api/v1/patching-jobs/{id}/jobruns/{run_id}/results/analysis
 Retrieves the patching job analysis results for the specific job ID and the associated job run ID.


Parameters

Name

Located in

Description

Default

Schema

id

path

Specifies the job ID whose details you want to retrieve.


integer*

page

query

Returns the specified page number of the results. The value starts at 0. By default, all the results are displayed on one page.


integer

patch_id

query

The ID of the patch whose analysis results you want to retrieve.


integer

patch_name

query

The name of the patch whose analysis results you want to retrieve.


string

patch_status

query

The patch status based on which the search must be run.


string
Enum: [
  "UNKNOWN",
  "ADDED",
  "UPDATED",
  "OBSOLETED",
  "FAILED",
  "DOWNLOADED",
  "FAILED_TO_DOWNLOAD",
  "MISSING",
  "INSTALLED",
  "NOT_APPLICABLE",
  "INVALID_URL",
  "EFFECTIVELY_INSTALLED",
  "MISSING_SP"
]

patch_type

query

The patch type based on which the search must be run. <br />The following patch types are available: <br />1. patch - represents 'Hotfix Windows Installable’, ‘RPM Installable’ and so on. <br />2. container - represents 'Windows Bulletin Installable’, ‘Red Hat Errata Installable’ and so on.


string
Enum: [
  "patch",
  "container"
]

run_id

path

Specifies the job run ID whose details you want to retrieve.


integer*

server_id

path

Specifies the server ID whose details you want to retrieve.


integer

server_name

query

Specifies the server name whose details you want to retrieve. The search is case-insensitive.


string

size

query

The number of items to be displayed on one page.


integer

Responses

Code

Description

Schema

200

OK

#Patch Analysis Results

401

Unauthorized


403

Forbidden


404

Not Found


GET /api/v1/patching-jobs/{id}/jobruns/{run_id}/results/analysis/servers
 Retrieves the patching job analysis results for the specific job ID and the associated job run ID for list of servers


Parameters

Name

Located in

Description

Default

Schema

id

path

Specifies the job ID whose details you want to retrieve.


integer*

page

query

Returns the specified page number of the results. The value starts at 0. By default, all the results are displayed on one page.


integer

run_id

path

Specifies the job run ID whose details you want to retrieve.


integer*

server_id

query

Specifies the server ID whose details you want to retrieve.


integer

server_name

query

Specifies the server name whose details you want to retrieve. The search is case-insensitive.


string

size

query

The number of items to be displayed on one page.


integer

Responses

Code

Description

Schema

200

OK

#TSSA Job Results Device list

401

Unauthorized


403

Forbidden


404

Not Found


GET /api/v1/patching-jobs/{id}/jobruns/{run_id}/results/remediation
 Retrieves the patching job remediation results for the specific job ID and the associated job run ID.


Parameters

Name

Located in

Description

Default

Schema

id

path

Specifies the job ID whose details you want to retrieve.


integer*

is_errors

query

Retrieves all the records that match this error flag status.


boolean

is_reboot

query

Retrieves all the records that match this reboot flag status.


boolean

page

query

Returns the specified page number of the results. The value starts at 0. By default, all the results are displayed on one page.


integer

run_id

path

Specifies the job run ID whose details you want to retrieve.


integer*

server_id

query

Specifies the server ID whose details you want to retrieve.


integer

server_name

query

Specifies the server name whose details you want to retrieve. The search is case-insensitive.


string

size

query

The number of items to be displayed on one page.


integer

Responses

Code

Description

Schema

200

OK

#Patch Remediation Results

401

Unauthorized


403

Forbidden


404

Not Found


PUT /api/v1/patching-jobs/{id}/schedules
 Updates schedules for a specific patching job ID.


Parameters

Name

Located in

Description

Default

Schema

id

path

Specifies the job ID for which the schedule needs to be updated.


integer*

update_schedule_request

body

Specifies the new schedule.


#Update Schedule Request

Responses

Code

Description

Schema

200

OK


201

Created


401

Unauthorized


403

Forbidden


404

Not Found



roles

APIs for retrieving, creating, updating, or deleting roles

GET /api/v1/roles
 Retrieves the list of all roles.


Parameters

Name

Located in

Description

Default

Schema

name

query

The name of the role whose details you want to retrieve.


string

page

query

Returns the specified page number of the results. The value starts at 0. By default, all the results are displayed on one page.


integer

size

query

The number of items to be displayed on one page.


integer

Responses

Code

Description

Schema

200

OK

#Role detail

401

Unauthorized


403

Forbidden


404

Not Found



servers

APIs for enrolling, decommissioning, retrieving details of servers, or updating their properties

GET /api/v1/servers
 Retrieves the details of all servers, matching any filter criteria. This list also includes the decommissioned servers.


Parameters

Name

Located in

Description

Default

Schema

agent_build_version

query

Filter for the build version of the agent on which the search must be run. For example, if you want to retrieve the details of the servers where the version of the agent is 8.9.4.112, specify 112 in this field.


string

agent_major_version

query

Filter for the major version of the agent on which the search must be run. For example, if you want to retrieve the details of the servers where the version of the agent is 8.9.4.112, specify 8 in this field.


string

agent_minor_version

query

Filter for the minor version of the agent on which the search must be run. For example, if you want to retrieve the details of the servers where the version of the agent is 8.9.4.112, specify 9 in this field.


string

agent_patch_version

query

Filter for the patch version of the agent on which the search must be run. For example, if you want to retrieve the details of the servers where the version of the agent is 8.9.4.112, specify 4 in this field.


string

agent_state

query

Filter for the state of the agent based on which the search must be run.


string
Enum: [
  "NotInstalled",
  "NotLicensed",
  "Unavailable",
  "Available"
]

device_state

query

Filter for the state of the device based on which the search must be run.


string
Enum: [
  "NotEnrolled",
  "Enrolled",
  "Decommissioned"
]

device_type

query

Filter for the device type based on which the search must be run.


string
Enum: [
  "server",
  "agentless_managed_object"
]

ip_address

query

The IP address of the server whose details you want to retrieve.


string

name

query

Name of the server whose details you want to retrieve. The search is case-insensitive.


string

os_name

query

Type of the operating system based on which the search must be run.


string
Enum: [
  "Windows",
  "Solaris",
  "Linux",
  "HP_UX",
  "AIX",
  "Unknown"
]

os_release

query

Release of the operating system based on which the search must be run.


string

os_vendor

query

Vendor of the operating system based on which the search must be run. For example, Microsoft.


string

os_version

query

Version of the operating system based on which the search must be run.


string

page

query

Returns the specified page number of the results. The value starts at 0. By default, all the results are displayed on one page.


integer

platform

query

Platform name based on which the search must be run. For example, Windows 64-bit.


string

size

query

The number of items to be displayed on one page.


integer

Responses

Code

Description

Schema

200

OK

#Server List

401

Unauthorized


403

Forbidden


404

Not Found


GET /api/v1/servers/{id}
 Retrieves the details of the server for a specified ID.


Parameters

Name

Located in

Description

Default

Schema

id

path

Specifies the server ID whose details you want to retrieve.


integer*

Responses

Code

Description

Schema

200

OK

#Server Details

401

Unauthorized


403

Forbidden


404

Not Found



sessions

APIs for session management

GET /api/v1/sessions
 Retrieves details for a specific session ID.


Responses

Code

Description

Schema

200

OK

#Session Response

401

Unauthorized


403

Forbidden


404

Not Found


POST /api/v1/sessions
 Creates an authentication token that contains the credentials and permissions for the user, and is required for all subsequent operations.


Parameters

Name

Located in

Description

Default

Schema

sessionRequest

body

Specifies the username, password, role name, and the authentication type used to log on to the application.


#Session Request

Responses

Code

Description

Schema

200

OK

#Session Response

201

Created


401

Unauthorized


403

Forbidden


404

Not Found


DELETE /api/v1/sessions
 Terminates the validity of a session token and the user is logged off from the application.


Responses

Code

Description

Schema

200

OK

boolean

204

No Content


401

Unauthorized


403

Forbidden



smart-groups

APIs for creating, updating, or retrieving details of smart groups

GET /api/v1/smart-groups/{type}
 Retrieves the list of all smart groups for a specified type.


Parameters

Name

Located in

Description

Default

Schema

page

query

Returns the specified page number of the results. The value starts at 0. By default, all the results are displayed on one page.


integer

size

query

The number of items to be displayed on one page.


integer

type

path

Filter for the type of the group whose details you want to retrieve. The default value is Server.


string*
Enum: [
  "server",
  "job",
  "depot",
  "component",
  "template",
  "device",
  "windowspatch",
  "redhatpatch",
  "solarispatch",
  "susepatch",
  "aixpatch",
  "debianpatch",
  "rpmlinuxpatch"
]

Responses

Code

Description

Schema

200

OK

#Smart Group List

401

Unauthorized


403

Forbidden


404

Not Found



GET /api/v1/smart-groups/{type}/{id}/members
Parameters

Name

Located in

Description

Default

Schema

id

path

Specifies the smart group ID whose members you want to retrieve.


integer*

page

query

Returns the specified page number of the results. The value starts at 0. By default, all the results are displayed on one page.


integer

size

query

The number of items to be displayed on one page.


integer

type

path

Filter for the type of the group whose details you want to retrieve. The default value is Server.


string*
Enum: [
  "server",
  "job",
  "depot",
  "component",
  "template",
  "device",
  "windowspatch",
  "redhatpatch",
  "solarispatch",
  "susepatch",
  "aixpatch",
  "debianpatch",
  "rpmlinuxpatch"
]

Responses

Code

Description

Schema

200

OK

#Smart group children

401

Unauthorized


403

Forbidden


404

Not Found


Object Definitions

Object

Schema

Agent Platform


 Information about RSCD agent platform details.


{
    id: integer
    Specifies ID of the RSCD agent platform.
    Example: 2
 
    name: string
    Specifies the RSCD Agent platform name.
    Example: Windows 64-bit
}

Agent State


 Information about the state of the RSCD agent.


{
    id: integer
    Specifies ID of the RSCD agent state on managed server.
    Example: 100
 
    name: string
    Specifies the RSCD agent state on managed server.
    Example: Available
}

Approval Request


 Information about Approval request for the schedule. This is not supported in TrueSight Server Automation 8.9.04.001 release.


{
    status: string
    Specifies the status of the approval request.
    Example: Approved
 
    type: string
    Specifies the type of approval request.
    Example: Change Management Manual Approval
 
    comments: string
    Specifies the comments of the approval request.
    Example: Go ahead , approved
 
    change_id: string
    Specifies the change ID of the approval request.
    Example: BMC Approval
 
    task_id: string
    Specifies the task ID of the approval request.
    Example: BMC Approval
}

Available timezone


 Information about available timezone ID and display name.


{
    id: string*
    Specifies ID of the timezone.
    Example: Asia/Calcutta
 
    display_name: string*
    Spcifies display name of the timezone.
    Example: India Standard Time
}

BLPackage

 Specifies the TrueSight Server Automation blpackage details.


{
    id: integer
    Specifies the depot object ID.
    Example: 1
 
    version_id: integer
    Specifies version of the depot object.
    Example: 1
 
    bl_value_id: integer
    Specifies the property set instance ID associated with the depot object.
    Example: 1
 
    name: string
    Specifies name of the depot object.
    Example: Name of depot object
 
    description: string
    Specifies description of the depot object.
    Example: Description of depot object
 
    file_location: string
    Specifies file location of the depot object.
    Example: //localhost/C/tmp
 
    parent_group_id: integer
    Specifies the depot object parent group ID.
    Example: 20004
 
    save_in: string
    Specifies the saved depot path.
    Example: Depot/TSSAObject
 
    object_type: #Generic Object Type for resources
    Specifies type ID of the depot object.
 
    user_created: #TSSA User
    Specifies TrueSight Server Automation user information that created the depot object.
 
    role_created: TSSA Role
    Specifies TrueSight Server Automation role information that created the depot object.
 
    user_modified: #TSSA User
    Specifies TrueSight Server Automation user information that last modified the depot object.
 
    role_modified: #TSSA Role
    Specifies TrueSight Server Automation role information that last modified the depot object.
 
    bl_acl: integer
    Specifies the access control list ID of the depot object.
    Example: 120001
 
    date_created: string
    Specifies the creation date of the depot object.
    Example: 2019-01-24 15:55:45.107
 
    date_modified: string
    Specifies the last modified date of the depot object.
    Example: 2019-01-24 15:55:45.14
 
    is_external_repository: boolean
    Specifies whether the depot object payload is stored on an external GIT repository.
}

BLPackages

 Information about the list of all blpackages.


{
    bl_packages: [
      List of blpackages.
 
       #BLPackage
    ]
 
    total_records: integer
    Number of blpackages that match current search criteria.
    Example: 12
}

Basic Deploy Job Definition

 Specifies definition of basic or software deploy job.


{
    job_options: #Basic deploy job options
    Job options for deploy job.
 
    phase_options: #Phase options
    Phase options for deploy job.
 
    schedule_options: #Basic Schedule options
    Specifies the different options for scheduling the jobs.
}

Basic Schedule options

 Information about schedule options.


{
    simulate: boolean
    Default : true or value set in DeployOptions.IS_SIMULATE_ENABLED property, Set this option to true to enable the Simulate phase of the deploy job. The Simulate phase performs a dry run of deployment without actually deploying a package.
 
    commit: boolean
    Default : true or value set in DeployOptions.IS_COMMIT_ENABLED property, Set this option to true to enable the Commit phase of the deploy job. During the Commit phase, packages are applied to target servers.
 
    staging: string
    Default : 'direct' or value set in DeployOptions.IS_STAGING_INDIRECT property, Set this option to true to enable indirect staging, which means the deploy job delivers the package to a repeater. During the Commit phase, the package is applied to the target server. Entering False means the job delivers the package directly to a target server.
    Enum: [
      "direct",
      "indirect"
    ]
 
    execute_job_now: boolean
    Default : false, Specifies whether you want to execute the job immediately or to a later time.
 
    schedule_details: #Deploy basic schedule settings
    Specifies the date and time when the deploy job should run.
}

Basic deploy job options

 Information about the deploy job options.


{
    logging_level: string
    Default : 'error_warnings' or the value set in DeployOptions.LOGGING_LEVEL property. Specifies the amount of logging information that the deploy job generates.
    Enum: [
      "error_warnings",
      "error_only",
      "all"
    ]
 
    single_job_mode: boolean
    Default : true, Set this option to true to instruct the deploy job to run in single-job mode - that is, it cannot run in parallel on a target server with any other deploy jobs. A job in single-job mode can only run when no other deploy job is currently being processed on the same target server. If other deploy jobs are processing, this deploy job waits until they are complete. While this job is being processed on a target server, no other deploy job can run.
 
    agent_deploy_queue_timeout: integer
    Default : 0 or value set in DeployOptions.AGENT_QUEUE_WAIT_TIMEOUT property, Recommended : 30 minutes. Enter a maximum period of time in minutes that the deploy job can wait for the agent on the target server to process this deploy job. Waits typically occur when agents have queued deploy jobs. If the specified period of time elapses, the job fails. If you do not enter any value or you enter 0, the job waits indefinitely.
 
    agent_connection_timeout: integer
    {{ Default : 0 or value set in DeployOptions.AGENT_CONNECTION_TIMEOUT property, Recommended : 60 minutes. Enter a maximum period of time in minutes that the deploy job can wait after the Application server loses contact with the target server. If the specified period of time elapses, the job fails. If you do not enter any value or you enter 0, the job waits indefinitely.}}
 
    single_user_mode: string
    (Applicable to UNIX target systems only) Specifies single-user mode behavior. The default value of this property is set in DeployOptions.USER_MODE_OPTIONS_UNIX_ONLY property.
    Enum: [
      "use_item_defined",
      "ignore_item_defined",
      "single_user_mode_no_reboot",
      "single_user_mode_with_reboot"
    ]
 
    reboot_options: string
    Specifies reboot behavior. The options are: use_item_defined, ignore_item_defined, use_item_defined_reboot_end_of_job, ignore_item_defined_reboot_end_of_job, consolidate_reboots.
    Enum: [
      "use_item_defined",
      "ignore_item_defined",
      "use_item_defined_reboot_end_of_job",
      "ignore_item_defined_reboot_end_of_job",
      "consolidate_reboots"
    ]
 
    reconfigure_reboot: string
    (Applicable to Solaris target systems only) Default : 'use_item_defined' or value set in DeployOptions.ITEM_RECONFIGURE_REBOOT_OPTIONS property. Specifies how the deploy job should handle item-level reconfiguration reboots. This option is only applicable when the value of the reboot_options is one of the following: use_item_defined_reboot_end_of_job, ignore_item_defined_reboot_end_of_job, consolidate_reboots.
    Enum: [
      "use_item_defined",
      "ignore_item_defined"
    ]
}

Catalog Details


 Information about general information about the catalog and its latest run status.


{
    id: integer
    Specifies the catalog ID.
    Example: 1
 
    name: string
    Specifies the name of the catalog.
    Example: Windows 10 catalog
 
    description: string
    Specifies the description of the catalog.
    Example: This is a sample description
 
    type: #Catalog Object Type
    TrueSight Server Automation model type of the catalog.
 
    group: #Group Parent Definition
    Fully qualified path of the catalog.
 
    status: #Catalog run status
    Specifies the status of the latest run of the catalog.
 
    acl_id: integer
    Specifies the RBAC Access Control List ID.
    Example: 2000200
}

Catalog Object Type


 Information about the resource type.


{
    id: integer
    Specifies the resource type ID in TrueSight Server Automation.
    Example: 5022
 
    name: string
    Specifies the name of the resource type in TrueSight Server Automation.
    Example: Windows Patch Catalog
}

Catalog Result


 Information about catalog results.


{
    status: string
    Gives the status of the last catalog update.
    Enum: [
      "passed",
      "failed",
      "cancelled",
      "warnings"
    ]
    Example: passed
 
    summary: [
      Gives the catalog update result summary
 
       #Patch Result Status
    ]
}

Catalog run status


 Information about the catalog status including its current state (progress_status). If the status is successful, it contains the summary of the included patches.


{
    job_run_id: integer
    Specifies the latest job run ID of the catalog.
    Example: 1
 
    progress_status: string
    Specifies the progress status of a ongoing catalog update.
    Enum: [
      "not_started",
      "running",
      "incomplete",
      "complete",
      "paused",
      "resuming",
      "aborted"
    ]
    Example: complete
 
    is_usable: boolean
    If the value is true, the catalog can be used for patch analysis.
    Example: True
 
    result: #Catalog Result
    Result of the latest catalog update
}

CatalogDetailsResponseBean

 Response containing detailed information of the respective catalog.


{
    id: integer
    Identifier of a catalog
    Example: 1
 
    schedules: [
      List of schedules for the catalog
 
       #Schedule
    ]
 
    acl: #RBAC Access Control List
    RBAC Access Control List
}

Child Deploy Job Runs list


 Information about TrueSight Server Automation child deploy job runs.


{
    job_run: #Job Run Identifier
    Identifier of the jobRun
 
    job: #Job Identifier
    Identifier of the job
 
    role_executed: #TSSA Role
    Details of the role that execute this job
 
    user_executed: #TSSA User
    Details of the user who execute this job
 
    start_time: string
    Specifies the start time of the job execution.
    Example: 2019-03-12 15:41:03.837
 
    end_time: string
    Specifies the end time of the job execution.
    Example: 2019-03-12 15:41:31.297
 
    progress_status: string
    Specifies the status of the progress of the job execution.
    Enum: [
      "not_started",
      "running",
      "incomplete",
      "complete",
      "paused",
      "resuming",
      "aborted"
    ]
    Example: complete
 
    object_type: #Deploy Job Object Type
    Type of Job executed
 
    has_errors: boolean
    Specifies if the job execution has any errors.
 
    has_warnings: boolean
    Specifies if the job execution has any warnings.
 
    is_cancelled: boolean
    Specifies if the job execution is cancelled.
 
    is_reset: boolean
    Specifies if the job execution is reset to be executed again.
 
    is_reboot: boolean
    Specifies if the job is waiting for a target server to be rebooted.
 
    schedule_id: integer
    Specifies the schedule ID.
    Example: 2
 
    children: [
      Specifies the attempt of job run
 
       #Deploy Child Job Run
    ]
}

Child Deploy job object type


 Information about the type of child of the deploy job.


{
    id: integer
    TrueSight Server Automation resource type ID.
    Example: 201
 
    name: string
    TrueSight Server Automation resource type name.
    Example: Deploy Dry Run Job
}

Deploy Child Job Run


 Information about the deploy child job run details.


{
    attempt_id: integer
    Specifies the attempt of job run
    Example: 1103
 
    job_run: #Job Run Identifier
    Identifier of the jobRun
 
    job: #Job Identifier
    Identifier of the job
 
    sequence_number: integer
    Specifies the sequence number of attempt
    Example: 1
 
    role_executed: #TSSA Role
    Details of the role that execute this job
 
    user_executed: #TSSA User
    Details of the user who execute this job
 
    start_time: string
    Specifies the start time of the job execution.
    Example: 2019-03-12 15:41:03.837
 
    end_time: string
    Specifies the end time of the job execution.
    Example: 2019-03-12 15:41:31.297
 
    progress_status: string
    Specifies the status of the progress of the job execution.
    Enum: [
      "not_started",
      "running",
      "incomplete",
      "complete",
      "paused",
      "resuming",
      "aborted"
    ]
    Example: complete
 
    object_type: #Child Deploy job object type
    Type of Job executed
 
    has_errors: boolean
    Specifies if the job execution has any errors.
 
    has_warnings: boolean
    Specifies if the job execution has any warnings.
 
    is_cancelled: boolean
    Specifies if the job execution is cancelled.
 
    is_reset: boolean
    Specifies if the job execution is reset to be executed again.
 
    is_reboot: boolean
    Specifies if the job is waiting for a target server to be rebooted.
 
    schedule_id: integer
    Specifies the schedule ID.
    Example: 2
}

Deploy Job Object Type


 Information about the type of the deploy job.


{
    id: integer
    TrueSight Server Automation resource type ID.
    Example: 30
 
    name: string
    TrueSight Server Automation resource type name.
    Example: Deploy job
}

Deploy Job Options


 Information about the options for the deploy job created by patch remediation job.


{
    job_options: #Job Options
    Job options for deploy job.
 
    phase_options: #Phase options
    Phase options for deploy job.
 
    schedule_options: #Schedule options
    Specifies the different options for scheduling the jobs.
 
    maintenance_window_options: #Maintenance window options
    Applicable only for Windows target servers.
}

Deploy Job Response

 Specifies response definition of software deploy or blpackage job.


{
    id: #Job Identifier *
    Job Identifier
 
    name: string*
    Name of the job.
    Example: TestJob
 
    description: string
    Description of the job.
    Example: TestJob
 
    group: #Job Group *
    {{ Specifies the job group details where the new job needs to be created.}}
 
    software_list: [
      Specifies identifier of the blpackage or depot software.
 
       #Deployable Software
    ]
 
    basic: #Basic Deploy Job Definition
    Specifies definition of basic or software deploy job. ('basic' and 'advanced' are mutually exclusive, if none are specified, 'basic' is assumed by default.)
 
    advanced: #Deploy Job Options
    Specifies definition of advanced deploy job. ('basic' and 'advanced' are mutually exclusive, if none are specified, 'basic' is assumed by default.) 'software_list' should contain only one BlPackage for advanced deploy job.
 
    max_parallel_targets: integer
    Default : 0, Specifies the number of target servers to process in parallel. Specify 0 to run the job in parallel on as many target servers as possible. If a decimal number is provided, then the nearest integer which is less than or equal to the number is considered.
 
    execution_override: boolean
    Default : false, This job will always execute as the user and role which schedules the job.
    Example: True
 
    targets: #Job Targets
    Specifies the servers where this job runs.
 
    notifications: #Job Run Notification
    Specifies options for defining default notifications that are generated when a job completes. If you have set up notifications for a particular scheduled job, those notifications are generated instead of default notifications.
 
    execute_now_schedule_id: integer
    Specifies the schedule ID for execute now.
 
    acl: #RBAC Access Control List
    RBAC Access Control List
}

Deploy Job Run

 Represents job run details.


{
    job_run: #Job Run Identifier
    Identifier of the jobRun.
 
    job: #Job Identifier
    Identifier of the job.
 
    role_executed: #TSSA Role
    Details of the role that execute this job.
 
    user_executed: #TSSA User
    Details of the user who execute this job.
 
    start_time: string
    Specifies the start time of the job execution.
    Example: 2019-03-12 15:41:03.837
 
    end_time: string
    Specifies the end time of the job execution.
    Example: 2019-03-12 15:41:31.297
 
    progress_status: string
    Specifies the status of the progress of the job execution.
    Enum: [
      "not_started",
      "running",
      "incomplete",
      "complete",
      "paused",
      "resuming",
      "aborted"
    ]
    Example: complete
 
    object_type: #Deploy Job Object Type
    Type of job executed.
 
    has_errors: boolean
    Specifies if the job execution has any errors.
 
    has_warnings: boolean
    Specifies if the job execution has any warnings.
 
    is_cancelled: boolean
    Specifies if the job execution is cancelled.
 
    is_reset: boolean
    Specifies if the job execution is reset to be executed again.
 
    is_reboot: boolean
    Specifies if the job is waiting for a target server to be rebooted.
 
    schedule_id: integer
    Specifies the schedule ID.
    Example: 2
}

Deploy Job Runs list

 TSSA deploy job runs list.


{
    job_runs: [
      List of job runs.
 
       #Deploy Job Run
    ]
 
    total_records: integer
    Number of job runs that match current search criteria.
    Example: 1
}

Deploy Job request

 Specifies request definition of software deploy or blpackage Job.


{
    name: string*
    Name of the job.
    Example: TSSAJob
 
    description: string
    Description of the job.
    Example: TSSA Job
 
    group: #Job Group *
    {{ Specifies the job group details where the new job needs to be created.}}
 
    software_list: [
      Specifies identifier of the blpackage or depot software.
 
       #Deployable Software
    ]
 
    basic: #Basic Deploy Job Definition
    Specifies definition of basic or software deploy job. ('basic' and 'advanced' are mutually exclusive, if none are specified, 'basic' is assumed by default.)
 
    advanced: #Deploy Job Options
    Specifies definition of advanced deploy job. ('basic' and 'advanced' are mutually exclusive, if none are specified, 'basic' is assumed by default.) 'software_list' should contain only one BlPackage for advanced deploy job.
 
    max_parallel_targets: integer
    Default : 0, Specifies the number of target servers to process in parallel. Specify 0 to run the job in parallel on as many target servers as possible. If a decimal number is provided, then the nearest integer which is less than or equal to the number is considered.
 
    execution_override: boolean
    Default : false, This job will always execute as the user and role which schedules the job.
    Example: True
 
    targets: #Job Targets
    Specifies the servers where this job runs.
 
    notifications: #Job Run Notification
    Specifies options for defining default notifications that are generated when a job completes. If you have set up notifications for a particular scheduled job, those notifications are generated instead of default notifications.
 
    execute_now: boolean
    Default : true, Specifies whether you want to execute the job immediately. Select false if you want to execute the job later at a scheduled time.
    Example: True
}

Deploy Schedule Model


 Information about job schedule.


{
    after_previous_phase: boolean
    (Not applicable for execute_at and simulate phase) Set this option to true to execute this stage immediately after the previous phase.
 
    once: #Schedule Once
    Specifies one-time scheduling of the job.
 
    timezone: string
    Specifies the time zone in which the job should run. The time includes the job's time zone relative to Greenwich Mean Time. For a recurring schedule, the system automatically accounts for differences in time zones and changes in daylight savings time. For example, if you schedule a job that should run weekly at 06:00 Eastern Standard Time, the job always runs at 06:00 Eastern Time, no matter whether standard or daylight savings time is in effect.
    Example: Asia/Calcutta
 
    priority: string
    {{ Specifies an execution priority level. The options are: Critical, High, Normal, Low, and Lowest.}}
    Enum: [
      "CRITICAL",
      "HIGH",
      "NORMAL",
      "LOW",
      "LOWEST"
    ]
 
    notifications: #Job Run Notification
    Specifies options for defining default notifications that are generated when a job completes. If you have set up notifications for a particular scheduled job, those notifications are generated instead of default notifications.
}

Deploy basic schedule settings

 Information about deploy schedule settings.


{
    execute_at: #Deploy Schedule Model
    Specifies the schedule to execute the job.
}

Deploy job options

 Information about the deploy job options.


{
    logging_level: string
    Default : 'error_warnings' or the value set in DeployOptions.LOGGING_LEVEL property. Specifies the amount of logging information that the deploy job generates.
    Enum: [
      "error_warnings",
      "error_only",
      "all"
    ]
 
    flow_control: string
    Default : 'by_server', Specifies how you want to control the flow of a job.
    Enum: [
      "by_server",
      "by_phase"
    ]
 
    all_host_commit: boolean
    Default : false, Set this option to true to instruct the job to undo the Commit phase for all target servers if any servers do not successfully complete the Commit phase. This option is only applicable when the flow_control option is set to by_phase.
 
    reset_job_on_failure: boolean
    Default : false, Set this option to true to allow a job to be run again even though the job failed at least one phase on at least one server. If you set this option to True, failed jobs are placed into a Reset state. If you do not set this option to true, a job cannot be run again until it completes successfully.
 
    single_job_mode: boolean
    Default : true, Set this option to true to instruct the deploy job to run in single-job mode - that is, it cannot run in parallel on a target server with any other deploy jobs. A job in single-job mode can only run when no other deploy job is currently being processed on the same target server. If other deploy jobs are processing, this deploy job waits until they are complete. While this job is being processed on a target server, no other deploy job can run.
 
    agent_deploy_queue_timeout: integer
    Default : 0 or value set in DeployOptions.AGENT_QUEUE_WAIT_TIMEOUT property, Recommended : 30 minutes. Enter a maximum period of time in minutes that the deploy job can wait for the agent on the target server to process this deploy job. Waits typically occur when agents have queued deploy jobs. If the specified period of time elapses, the job fails. If you do not enter any value or you enter 0, the job waits indefinitely.
 
    agent_connection_timeout: integer
    {{ Default : 0 or value set in DeployOptions.AGENT_CONNECTION_TIMEOUT property, Recommended : 60 minutes. Enter a maximum period of time in minutes that the deploy job can wait after the Application server loses contact with the target server. If the specified period of time elapses, the job fails. If you do not enter any value or you enter 0, the job waits indefinitely.}}
 
    single_user_mode: string
    (Applicable to UNIX target systems only) Specifies single-user mode behavior. The default value of this property is set in DeployOptions.USER_MODE_OPTIONS_UNIX_ONLY property.
    Enum: [
      "use_item_defined",
      "ignore_item_defined",
      "single_user_mode_no_reboot",
      "single_user_mode_with_reboot"
    ]
 
    reboot_options: string
    Specifies reboot behavior. The options are: use_item_defined, ignore_item_defined, use_item_defined_reboot_end_of_job, ignore_item_defined_reboot_end_of_job, consolidate_reboots.
    Enum: [
      "use_item_defined",
      "ignore_item_defined",
      "use_item_defined_reboot_end_of_job",
      "ignore_item_defined_reboot_end_of_job",
      "consolidate_reboots"
    ]
 
    reconfigure_reboot: string
    (Applicable to Solaris target systems only) Default : 'use_item_defined' or value set in DeployOptions.ITEM_RECONFIGURE_REBOOT_OPTIONS property. Specifies how the deploy job should handle item-level reconfiguration reboots. This option is only applicable when the value of the reboot_options is one of the following: use_item_defined_reboot_end_of_job, ignore_item_defined_reboot_end_of_job, consolidate_reboots.
    Enum: [
      "use_item_defined",
      "ignore_item_defined"
    ]
}

Deploy job results

 TSSA deploy job results device list.


{
    list: [
      List of all deploy job results of target server that match the search criteria.
 
       #Device Result
    ]
 
    total_records: integer
    Number of deploy job results of target servers that match current search criteria.
    Example: 1
}

Deploy schedule settings


 Information about deploy schedule settings.


{
    execute_at: #Deploy Schedule Model
    Specifies the schedule to execute the job.
 
    simulate_at: #Deploy Schedule Model
    Specifies the schedule to simulate the job.
 
    stage_at: #Deploy Schedule Model
    Specifies the schedule to stage the job.
 
    commit_at: #Deploy Schedule Model
    Specifies the schedule to commit the job.
}

Deployable Software

 Specifies deployable software to be set on deploy job.


{
    id: integer
    Specifies ID of the depot software or blpackage.
    Example: 1
 
    properties: {
      Specifies overriden properties for depot software or blpackage.
    }
}

Depot Group


 Information about the depot group such as ID and absolute path of the group.


{
    id: integer
    Specifies the depot group ID.
    Example: 1000001
 
    path: string
    Specifies the absolute path of the depot group.
    Example: /Depot
}

Depot Software Errata


 Information about Errata type of depot software.


{
    id: integer
    Specifies the depot object ID.
    Example: 1
 
    version_id: integer
    Specifies version of the depot object.
    Example: 1
 
    bl_value_id: integer
    Specifies the property set instance ID associated with the depot object.
    Example: 1
 
    name: string
    Specifies name of the depot object.
    Example: Name of depot object
 
    description: string
    Specifies description of the depot object.
    Example: Description of depot object
 
    parent_group_id: integer
    Specifies the depot object parent group ID.
    Example: 20004
 
    object_type: #Object Type
    Specifies type ID of the depot object.
 
    user_created: #TSSA User
    Specifies TrueSight Server Automation user information that created the depot object.
 
    role_created: #TSSA Role
    Specifies TrueSight Server Automation role information that created the depot object.
 
    user_modified: #TSSA User
    Specifies TrueSight Server Automation user information that last modified the depot object.
 
    role_modified: #TSSA Role
    Specifies TrueSight Server Automation role information that last modified the depot object.
 
    bl_acl: integer
    Specifies the access control list ID of the depot object.
    Example: 120001
 
    date_created: string
    Specifies the creation date of the depot object.
    Example: 2019-01-24 15:55:45.107
 
    date_modified: string
    Specifies the last modified date of the depot object.
    Example: 2019-01-24 15:55:45.14
 
    is_external_repository: boolean
    Specifies whether the depot object payload is stored on an external GIT repository.
 
    software_type: #Depot Software Type
    Specifies type of the depot software.
 
    os: #Operating System Detail
    Specifies associated OS information for the depot software.
 
    install_command: string
    Specifies installation command line for the software.
    Example: "SOURCE" -q -z
 
    uninstall_command: string
    Specifies uninstallation command line for the software.
    Example: "WINDIR\\$NTUninstall??HOTFIXNAME??$\\spuninst
spuninst.exe" /u /q /z

 
    advisory: string
    Specifies advisory of the errata.
 
    synopsis: string
    Specifies synopsis of the errata.
 
    issue_date: string
    Specifies issue date of the errata
 
    errata_type: string
    Specifies name of classification of the errata as defined by vendor.
 
    topic: string
    Specifies name of the errata topic.
 
    severity: string
    Specifies the severity of the errata.
 
    os_arch: string
    Specifies the errata specified for the Operating System architecture.
 
    cve_ids: string
    Specifies the list of Common Vulnerabilities and Exposures (CVE) IDs.
}

Depot Software Hotfix


 Information about Hotfix type of depot software.


{
    id: integer
    Specifies the depot object ID.
    Example: 1
 
    version_id: integer
    Specifies version of the depot object.
    Example: 1
 
    bl_value_id: integer
    Specifies the property set instance ID associated with the depot object.
    Example: 1
 
    name: string
    Specifies name of the depot object.
    Example: Name of depot object
 
    description: string
    Specifies description of the depot object.
    Example: Description of depot object
 
    parent_group_id: integer
    Specifies the depot object parent group ID.
    Example: 20004
 
    object_type: #Object Type
    Specifies type ID of the depot object.
 
    user_created: #TSSA User
    Specifies TrueSight Server Automation user information that created the depot object.
 
    role_created: #TSSA Role
    Specifies TrueSight Server Automation role information that created the depot object.
 
    user_modified: #TSSA User
    Specifies TrueSight Server Automation user information that last modified the depot object.
 
    role_modified: #TSSA Role
    Specifies TrueSight Server Automation role information that last modified the depot object.
 
    bl_acl: integer
    Specifies the access control list ID of the depot object.
    Example: 120001
 
    date_created: string
    Specifies the creation date of the depot object.
    Example: 2019-01-24 15:55:45.107
 
    date_modified: string
    Specifies the last modified date of the depot object.
    Example: 2019-01-24 15:55:45.14
 
    is_external_repository: boolean
    Specifies whether the depot object payload is stored on an external GIT repository.
 
    software_type: #Depot Software Type
    Specifies type of the depot software.
 
    os: #Operating System Detail
    Specifies associated OS information for the depot software.
 
    install_command: string
    Specifies installation command line for the software.
    Example: "SOURCE" -q -z
 
    uninstall_command: string
    Specifies uninstallation command line for the software.
    Example: "WINDIR\\$NTUninstall??HOTFIXNAME??$\\spuninst
spuninst.exe" /u /q /z

 
    patch_product: #Patch product
    Specifies the name of the patch product associated with the hotfix.
 
    language: #Language
    Specifies the language of the hotfix.
 
    service_pack: #Service Pack
    Specifies service pack information associated with the hotfix.
 
    hotfix_type: #Hotfix Type
    Specifies the type information of the hotfix.
 
    bulletin_id: string
    Specifies the bulletin ID associated with the hotfix.
    Example: CR16-001
 
    patch_guid: string
    Specifies the GUID provided by patch engine.
    Example: 000170aa-0000-0000-0000-000000000000
 
    patch_name: string
    Specifies vendor provided name of the hotfix.
    Example: Windows8.1-2012-R2-KB3185331-x64.msu
 
    shavlik_file_name: string
    Specifies name of the hotfix assigned by patch engine.
    Example: Windows8.1-KB3185331-x64.msu
 
    custom_install: boolean
    Specifies whether the hotfix is configured for custom install.
 
    q_number: string
    Specifies the Knowledge Base (KB) number that is used to identify Microsoft patches.
    Example: Q3185331
 
    cve_ids: string
    Specifies the list of Common Vulnerabilities and Exposures (CVE) IDs.
    Example: CVE-2016-0073, CVE-2016-4286, CVE-2016-0075, CVE-2016-0079
 
    cve_url: string
    Specifies the URL to Common Vulnerabilities and Exposures (CVE) details page.
    Example: http://www.cve.mitre.org/cgi-bin/cvename.cgi?name=CVE-2016-4286
 
    kb_url: string
    Specifies the URL to Knowledge Base (KB) article.
    Example: http://support.microsoft.com/kb/3185331
 
    patch_impact: string
    Specifies vendor defined impact definition for a hotfix.
    Enum: [
      "Unknown",
      "Critical",
      "Important",
      "Low",
      "Moderate"
    ]
    Example: Critical
 
    vendor_name: string
    Specifies name of the patch vendor.
    Example: Microsoft
 
    patch_type: string
    Specifies name of classification of the patch as defined by vendor.
    Enum: [
      "microsoft_security_patch",
      "non_mircosoft_security_patch",
      "software_distribution",
      "security_tools",
      "non_security_patch"
    ]
    Example: software_distribution
 
    shavlik_download_url: string
    Specifies the download URL for the patch as provided by the vendor.
    Example: https://download.microsoft.com/download/0/7/C/07C37A75-030C-40B5-AB68-321FA94EC20C/Windows8.1-KB3185331-x64.msu
 
    date_posted: string
    Specifies date of the patch release.
    Example: 2016-10-11 00:00:00.0
 
    superseded_by: string
    Specifies name of the superceding patch.
    Example: Q3197874:windows8.1-2012-R2-kb3197874-x64.msu
 
    superseded_by_score: integer
    Specifies score of the superseding patch.
 
    size: integer
    Specifies size of the patch (in bytes).
    Example: 122288074
 
    reboot_required: boolean
    Specifies whether the patch requires reboot.
    Example: True
 
    uninstallable: boolean
    Specifies whether the patch can be uninstalled.
    Example: True
}

Depot Software RPMs


 Information about RPMs type of depot software.


{
    id: integer
    Specifies the depot object ID.
    Example: 1
 
    version_id: integer
    Specifies version of the depot object.
    Example: 1
 
    bl_value_id: integer
    Specifies the property set instance ID associated with the depot object.
    Example: 1
 
    name: string
    Specifies name of the depot object.
    Example: Name of depot object
 
    description: string
    Specifies description of the depot object.
    Example: Description of depot object
 
    parent_group_id: integer
    Specifies the depot object parent group ID.
    Example: 20004
 
    object_type: #Object Type
    Specifies type ID of the depot object.
 
    user_created: #TSSA User
    Specifies TrueSight Server Automation user information that created the depot object.
 
    role_created: #TSSA Role
    Specifies TrueSight Server Automation role information that created the depot object.
 
    user_modified: #TSSA User
    Specifies TrueSight Server Automation user information that last modified the depot object.
 
    role_modified: #TSSA Role
    Specifies TrueSight Server Automation role information that last modified the depot object.
 
    bl_acl: integer
    Specifies the access control list ID of the depot object.
    Example: 120001
 
    date_created: string
    Specifies the creation date of the depot object.
    Example: 2019-01-24 15:55:45.107
 
    date_modified: string
    Specifies the last modified date of the depot object.
    Example: 2019-01-24 15:55:45.14
 
    is_external_repository: boolean
    Specifies whether the depot object payload is stored on an external GIT repository.
 
    software_type: #Depot Software Type
    Specifies type of the depot software.
 
    os: #Operating System Detail
    Specifies associated OS information for the depot software.
 
    install_command: string
    Specifies installation command line for the software.
    Example: "SOURCE" -q -z
 
    uninstall_command: string
    Specifies uninstallation command line for the software.
    Example: "WINDIR\\$NTUninstall??HOTFIXNAME??$\\spuninst
spuninst.exe" /u /q /z

 
    os_arch: string
    Specifies the Operating System and Architecture identifier name for the RPM.
    Example: RHES6x86_64
 
    channel: string
    Specifies the name of the redhat channel.
 
    errata: string
    Specifies the Red Hat errata ID associated with the RPM.
 
    summary: string
    Specifies the summary of the RPM.
    Example: Implements the server side of the SPICE protocol
 
    rpm_group: string
    Specifies the group associated with the RPM.
    Example: System Environment/Libraries
 
    build_date: string
    Specifies the build date of the RPM.
    Example: 2016-01-26 00:00:00.0
 
    vendor_name: string
    Specifies the name of the vendor.
    Example: Red Hat, Inc.
 
    license: string
    Specifies licence id associated with the RPM.
    Example: LGPLv2+
 
    size: string
    Specifies the size of the RPM.
    Example: 1193716
 
    package: string
    Specifies the package name.
    Example: spice-server
 
    rpm_arch: string
    Specifies the architecture of the RPM.
    Example: x86_64
 
    rpm_release: string
    Specifies the release date of the RPM.
    Example: 13.el6
 
    rpm_version: string
    Specifies the version of the RPM.
    Example: 0.12.4
}

Depot Software Type


 Information about the default type of depot software.


{
    id: integer
    Specifies the software type ID.
    Example: 100001
 
    name: string
    Specifies the name of software type.
    Example: OS Service Pack
 
    location: string
    Specifies the location of the software.
}

Device Result

 Represents job run result details.


{
    server: #Servers *
    Specifies the Server Identifier.
 
    object_type: #TSSA Resource *
    Specifies the Object Type of result.
 
    start_time: string
    Specifies the start time of the job execution on the target server or device.
    Example: 2019-03-12 15:41:03.837
 
    end_time: string
    Specifies the end time of the job execution on the target server or device.
    Example: 2019-03-12 15:41:31.297
 
    exit_code: #ExitCode
    Specifies the exit code of the job on the target
 
    progress_status: string
    Specifies the status of the progress of the job execution on the target server or device.
    Enum: [
      "not_started",
      "running",
      "incomplete",
      "complete",
      "paused",
      "resuming",
      "aborted"
    ]
    Example: complete
 
    error_code: string
    The error code/message on the target server or device.
 
    has_errors: boolean
    Specifies if the job execution has any errors on the target server or device.
 
    has_warnings: boolean
    Specifies if the job execution has any warnings on the target server or device.
 
    is_attempted: boolean
    Specifies if the job execution is attemepted on the target server or device.
 
    is_reboot: boolean
    Specifies if the job is waiting for a target server to be rebooted.
}

Device State


 Information about the device state.


{
    id: integer
    Specifies ID of the device state managed by TrueSight Server Automation.
    Example: 50
 
    name: string
    Specifies state of the device managed by TrueSight Server Automation.
    Example: Enrolled
}

Device Type


 Information about the device type.


{
    id: integer
    Specifies device type ID of the managed server.
    Example: 1
 
    name: string
    Specifies device type name of the managed server.
    Example: Server
}

Email Notification


 Information about email notifications when a scheduled job is completed.


{
    id: integer
    {{ Specifies the system-generated unique ID for the notification. Value of this attribute will be ignored if notification is added or updated.}}
    Example: 200001
 
    value: string
    Specifies the email addresses of the accounts to notify when a job completes with the status that you specify. Separate multiple email addresses with semicolons or commas. For example, sysadmin@bmc.com;sysmgr@bmc.com,sysuser@bmc.com.
    Example: BLAdmin123@gmail.com,TestUser123@gmail.com
 
    success: boolean
    Set this option to True to send notifications in case the job is completed successfully.
    Example: True
 
    failure: boolean
    {{ Set this option to True to send notifications in case the job is not completed successfully.}}
 
    aborted: boolean
    Set this option to True to send notifications in case the job is aborted in between.
    Example: True
 
    append_patch_analysis_result: boolean
    (Applicable for patching jobs) Set this option to True to include detailed patch analysis results in the notification.
    Example: True
 
    size_limit: integer
    Default : 1000 KB. (Applicable for patching jobs) Specifies the maximum limit for the size of email that is generated by appending patch analysis results.
    Example: 1000
 
    list_failed_servers: boolean
    (Applicable for patching jobs) Set this option to True to send notifications that include the list all servers on which a job has failed.
    Example: True
}

ExitCode

 Provides information about the exit code on the server.


{
    id: integer
    Identifier of the exit code.
    Example: 1
 
    name: string
    Displays the actual message based on the exit code identifier.
    Example: localhost
}

Generic Object Type

 Generic Object Type in TSSA like job, group, smartGroup etc.


{
    id: integer
    Specifies the Object ID.
    Example: 1000001
 
    name: string
    Specifies the Object name.
    Example: TestGroup
 
    verison_id: integer
    Specifies version id of the obect. This is not applicable for object like server,folders and smartGroups
    Example: 100001
 
    object_type: #Object Type
    Specifies type ID of the depot object.
}

Generic Object Type for resources

 Represents object type details.


{
    id: integer
    TrueSight Server Automation resource type ID.
    Example: 68
 
    name: string
    TrueSight Server Automation resource type name.
    Example: Object Type
}

Group


 Information about group basic details including the type of group.


{
    id: integer
    Specifies the group ID.
    Example: 1000001
 
    name: string
    Specifies the group name.
    Example: TestGroup
 
    path: string
    Specifies absolute path of the group.
    Example: /
 
    type: #Group Type
    Type identifier and name of group (Server Smart Group, Job Group etc).
}

Group Definition


 Information about the group and the parent group.


{
    id: integer
    Specifies the group ID.
    Example: 1000001
 
    name: string
    Specifies the group name.
    Example: TestGroup
 
    path: string
    Specifies absolute path of the group.
    Example: /
 
    description: string
    Specifies the description of the group.
    Example: Server Group
 
    parent: #Group Parent Definition
    Specifies the parent of the group.
}

Group Details


 Detailed information about the group.


{
    _links: [
       #Link
    ]
    group: #Group Definition
}

Group List


 Information about list of all groups.


{
    _links: [
       #Link
    ]
    groups: [
      Specifies the group details.
 
       #Group Definition
    ]
 
    total_records: integer
    The number of records that match the search criteria.
    Example: 12
}

Group Parent Definition


 Information about the parent group.


{
    id: integer
    Specifies the group ID.
    Example: 1000001
 
    name: string
    Specifies the group name.
    Example: TestGroup
 
    path: string
    Specifies absolute path of the group.
    Example: /
}

Group Request


 Information about the group name, parent group ID, and the description for the new group.


{
    name: string*
    Specifies the group name to be created.
    Example: New group Name
 
    parent_group_id: integer
    Specifies the parent group ID for the new group to be created. If not provided, it assumes root as parent. API supports following root groups - Component Template, Components, Depot, Jobs and Servers.
    Example: 1000002
 
    description: string
    Specifies the description for the group to be created.
    Example: New group description
}

Group Type


 Information about group type.


{
    id: integer
    Specifies the resource type ID in TrueSight Server Automation.
    Example: 5007
 
    name: string
    Specifies the resource type name in TrueSight Server Automation.
    Example: Server Smart Group
}

Hotfix Type


 Information about the type of hotfix.


{
    id: integer
    Specifies the ID of hotfix type.
    Example: 3
 
    name: string
    Specifies the name of hotfix type.
    Example: SP1
 
    bl_value_id: integer
    Specifies the property set instance ID associated with the hotfix.
    Example: 8010
}

Include Exclude List


 Information about the list of patches to be included or excluded.


{
    include: [
      List of patch indentifiers to be included.
 
      integer
    ]
 
    exclude: [
      List of patch indentifiers to be excluded.
 
      integer
    ]
}

Include Exclude List for patches and patch groups


 Information about the list of patches and patch groups to be included or excluded.


{
    patch_list: #Include Exclude List
    Specifies the list of patch IDs to be included or excluded in patch analysis. Provide depot object IDs for the patches.
 
    patch_group_list: #Include Exclude List
    Specifies the list of patch group IDs to be included or excluded in patch analysis. Provide group IDs for the patch smart group.
}

Job Group


 Information about the job group such as ID and absolute path of the group.


{
    id: integer
    Specifies the job group ID.
    Example: 1000001
 
    path: string
    Specifies the absolute path of the job group.
    Example: /Jobs
}

Job Identifier


 Information about the TrueSight Server Automation job identifier.


{
    job_id: integer
    Specifies the job ID.
    Example: 21
 
    job_version: integer
    Specifies the job version.
    Example: 6
}

Job Options


 Information about the deploy job options.


{
    logging_level: string
    Default : 'error_warnings' or the value set in DeployOptions.LOGGING_LEVEL property. Specifies the amount of logging information that the deploy job generates.
    Enum: [
      "error_warnings",
      "error_only",
      "all"
    ]
 
    flow_control: string
    Default : 'by_server', Specifies how you want to control the flow of a job.
    Enum: [
      "by_server",
      "by_phase"
    ]
 
    all_host_commit: boolean
    Default : false, Set this option to true to instruct the job to undo the Commit phase for all target servers if any servers do not successfully complete the Commit phase. This option is only applicable when the flow_control option is set to by_phase.
 
    reset_job_on_failure: boolean
    Default : false, Set this option to true to allow a job to be run again even though the job failed at least one phase on at least one server. If you set this option to True, failed jobs are placed into a Reset state. If you do not set this option to true, a job cannot be run again until it completes successfully.
 
    single_job_mode: boolean
    Default : true, Set this option to true to instruct the deploy job to run in single-job mode - that is, it cannot run in parallel on a target server with any other deploy jobs. A job in single-job mode can only run when no other deploy job is currently being processed on the same target server. If other deploy jobs are processing, this deploy job waits until they are complete. While this job is being processed on a target server, no other deploy job can run.
 
    agent_deploy_queue_timeout: integer
    Default : 0 or value set in DeployOptions.AGENT_QUEUE_WAIT_TIMEOUT property, Recommended : 30 minutes. Enter a maximum period of time in minutes that the deploy job can wait for the agent on the target server to process this deploy job. Waits typically occur when agents have queued deploy jobs. If the specified period of time elapses, the job fails. If you do not enter any value or you enter 0, the job waits indefinitely.
 
    agent_connection_timeout: integer
    {{ Default : 0 or value set in DeployOptions.AGENT_CONNECTION_TIMEOUT property, Recommended : 60 minutes. Enter a maximum period of time in minutes that the deploy job can wait after the Application server loses contact with the target server. If the specified period of time elapses, the job fails. If you do not enter any value or you enter 0, the job waits indefinitely.}}
 
    single_user_mode: string
    (Applicable to UNIX target systems only) Specifies single-user mode behavior. The default value of this property is set in DeployOptions.USER_MODE_OPTIONS_UNIX_ONLY property.
    Enum: [
      "use_item_defined",
      "ignore_item_defined",
      "single_user_mode_no_reboot",
      "single_user_mode_with_reboot"
    ]
 
    reboot_options: string
    Specifies reboot behavior. The options are: use_item_defined, ignore_item_defined, use_item_defined_reboot_end_of_job, ignore_item_defined_reboot_end_of_job, consolidate_reboots.
    Enum: [
      "use_item_defined",
      "ignore_item_defined",
      "use_item_defined_reboot_end_of_job",
      "ignore_item_defined_reboot_end_of_job",
      "consolidate_reboots"
    ]
 
    reconfigure_reboot: string
    (Applicable to Solaris target systems only) Default : 'use_item_defined' or value set in DeployOptions.ITEM_RECONFIGURE_REBOOT_OPTIONS property. Specifies how the deploy job should handle item-level reconfiguration reboots. This option is only applicable when the value of the reboot_options is one of the following: use_item_defined_reboot_end_of_job, ignore_item_defined_reboot_end_of_job, consolidate_reboots.
    Enum: [
      "use_item_defined",
      "ignore_item_defined"
    ]
}

Job Run Details


 Detailed information about the job runs.


{
    job_run: #Job Run Identifier
    Identifier of the jobRun
 
    job: #Job Identifier
    Identifier of the job
 
    role_executed: #TSSA Role
    Details of the role that execute this job
 
    user_executed: #TSSA User
    Details of the user who execute this job
 
    start_time: string
    Specifies the start time of the job execution.
    Example: 2019-03-12 15:41:03.837
 
    end_time: string
    Specifies the end time of the job execution.
    Example: 2019-03-12 15:41:31.297
 
    progress_status: string
    Specifies the status of the progress of the job execution.
    Enum: [
      "not_started",
      "running",
      "incomplete",
      "complete",
      "paused",
      "resuming",
      "aborted"
    ]
    Example: complete
 
    object_type: #TSSA Resource
    Type of Job executed
 
    has_errors: boolean
    Specifies if the job execution has any errors.
 
    has_warnings: boolean
    Specifies if the job execution has any warnings.
 
    is_cancelled: boolean
    Specifies if the job execution is cancelled.
 
    is_reset: boolean
    Specifies if the job execution is reset to be executed again.
 
    is_reboot: boolean
    Specifies if the job is waiting for a target server to be rebooted.
 
    schedule_id: integer
    Specifies the schedule ID.
    Example: 2
}

Job Run Event


 Information about the model to represent the job run event.


{
    id: integer
    Specifies the event ID of the job run.
 
    type: string
    Specifies the type of the job run event.
    Enum: [
      "info",
      "error",
      "warning",
      "fine",
      "finer",
      "finest"
    ]
 
    server_id: integer
    Specifies the server ID for which the specific event is generated.
 
    server_name: string
    Specifies the server name for which the specific event is generated.
 
    date: string
    Specifies the date and time stamp of the event.
 
    message: string
    Displays the message which is logged as part of the event.
 
    job_type: #TSSA Resource
    Shows the type of job for which the events are generated
}

Job Run Events


 Information about job run events.


{
    job_run_events: [
      List of all job run events that match the search criteria.
 
       #Job Run Event
    ]
 
    total_records: integer
    The number of job runs that match the search criteria.
    Example: 1
}

Job Run Identifier


 Information about the job runs.


{
    job_run_id: integer
    Specifies the job run ID for the job.
    Example: 23
}

Job Run Notification


 Information about options for defining default notifications that are generated when a job completes. If you have set up notifications for a particular scheduled job, those notifications are generated instead of default notifications.


{
    email: #Email Notification
    Lets you send email notifications when a scheduled job is completed.
 
    snmp_trap: #Notification
    Lets you send SNMP traps notifications when a scheduled job is completed.
 
    notification_url: #Notification URL
    Lets you invoke a callback url when a scheduled job is completed.
}

Job Targets


 Information about the model to represent job targets (server groups / servers).


{
    server_groups: [
      Specifies the server group where the job runs against the servers assigned to that group at the time of execution. The servers assigned to smart groups can change dynamically based on their server properties. You can modify static server groups manually by adding or removing servers.
 
       #Server Group Definition
    ]
 
    servers: [
      Specifies the servers where this job runs.
 
       #Servers
    ]
}

Language


 Information about Hotfix language.


{
    id: integer
    Specifies the patch language ID.
    Example: 6
 
    code: string
    Specifies the patch language code number.
    Example: 0407
 
    name: string
    Specifies the patch language name.
    Example: German
 
    extension: string
    Specifies the patch language extension.
    Example: de
}


 Click here to expand...


{
    deprecation: string
    href: string
    hreflang: string
    media: string
    rel: string
    templated: boolean
    title: string
    type: string
}

List Of Catalogs


 Information about the list of all catalogs.


{
    _links: [
       #Link
    ]
    catalogs: [
      List of catalogs
 
       #Catalog Details
    ]
 
    total_records: integer
    Number of catalogs that match current search criteria.
    Example: 12
}

List Of Patches


 Information about the list of all patches in the catalog.


{
    _links: [
       #Link
    ]
    patches: [
      List of patches matching current criteria
 
       #Patch List
    ]
 
    total_records: integer
    Number of patches in the catalog matching current criteria
    Example: 12
}

List Of Patching Jobs

 Information about the list of all patching jobs.


{
    _links: [
       #Link
    ]
    patching_job_list: [
      List of patching jobs
 
       #Patching Job Details
    ]
 
    total_records: integer
    The number of records that match the search criteria.
    Example: 10
}

Maintenance window options


 Information about maintenance or exclusion window options of deploy job.


{
    pause: boolean
    Set this option to True to pause the job when the maintenance window ends or when the exclusion window begins (the default).
 
    pause_before: integer
    Default : 0. Specifies the number of minutes and instructs the deploy job to pause specified minutes before the completion of the maintenance window. By default, the pause occurs only when the maintenance window ends or the exclusion window begins. The maximum value allowed is 30 minutes, and the minimum allowed value is 0. Anything below 0 will be set to 0 and anything above 30 will be set to 30.
}

NSH Script Details

 Detailed information about the nsh script.


{
    id: integer
    Specifies the depot object ID.
    Example: 1
 
    version_id: integer
    Specifies version of the depot object.
    Example: 1
 
    bl_value_id: integer
    Specifies the property set instance ID associated with the depot object.
    Example: 1
 
    name: string
    Specifies name of the depot object.
    Example: Name of depot object
 
    description: string
    Specifies description of the depot object.
    Example: Description of depot object
 
    file_location: string
    Specifies file location of the depot object.
    Example: //localhost/C/tmp
 
    parent_group_id: integer
    Specifies the depot object parent group ID.
    Example: 20004
 
    file_extension: string
    Specifies the extension of the file.
    Example: txt
 
    save_in: string
    Specifies the saved depot path.
    Example: Depot/TSSAObject
 
    repository_type: string
    Specifies the type of repository used to save script file.
    Example: TSSA Repository
 
    script_type_id: integer
    Specifies the script type ID.
    Example: 2
 
    object_type: #NSH script object type
    Specifies type ID of the depot object.
 
    script_type: string
    Specifies the script type name.
    Example: Execute the script once, passing the host List
 
    user_created: #TSSA User
    Specifies TrueSight Server Automation user information that created the depot object.
 
    role_created: #TSSA Role
    Specifies TrueSight Server Automation role information that created the depot object.
 
    user_modified: #TSSA User
    Specifies TrueSight Server Automation user information that last modified the depot object.
 
    role_modified: #TSSA Role
    Specifies TrueSight Server Automation role information that last modified the depot object.
 
    bl_acl: integer
    Specifies the access control list ID of the depot object.
    Example: 120001
 
    date_created: string
    Specifies the creation date of the depot object.
    Example: 2019-01-24 15:55:45.107
 
    date_modified: string
    Specifies the last modified date of the depot object.
    Example: 2019-01-24 15:55:45.14
 
    is_external_repository: boolean
    Specifies whether the depot object payload is stored on an external GIT repository.
}

NSH Script Header

 Specifies identifier of nsh script that is to be set on nsh script job.


{
    id: integer
    Specifies ID of the nsh script. (If this is specified along with path, path value will be ignored).
    Example: 1
 
    path: string
    Specifies path of the nsh script. (If this is specified along with ID, this value will be ignored).
    Example: /NSHScript/TestNSHScript
}

NSH Script Job Parameter Name Value

 NSH script job parameters name value pair.


{
    id: integer*
    Specifies the parameter ID.
    Example: 1
 
    name: string
    Name of the parameter.
    Example: Test
 
    value: string
    Specifies the parameter value. If default value is null and editable, then this value is mandatory.
    Example: 3
 
    flag: string
    Flag for the parameter.
    Example: -test
 
    skip_flag: boolean
    Default : false, Specifies nsh script flag is optional. Use = false and Ignore = true.
    Example: True
 
    skip_value: boolean
    Default : false, Specifies nsh script flag value is optional. Use = false and Ignore = true.
    Example: True
 
    value_runtime_usage: boolean
    Flag value is required at runtime. Non-existence of this property means optional.
    Example: True
 
    flag_runtime_usage: boolean
    Flag is required at runtime. Non-existence of this property means optional.
    Example: True
 
    editable: boolean
    Flag value is editable.
    Example: True
 
    description: string
    Description for the flag.
    Example: Test flag
}

NSH Script Job Parameter Value

 NSH script job parameters value.


{
    id: integer*
    Specifies the parameter ID.
    Example: 1
 
    value: string
    Specifies the parameter value. If default value is null and editable, then this value is mandatory.
    Example: 3
 
    skip_flag: boolean
    Default : false, Specifies nsh script flag is optional. Use = false and Ignore = true.
    Example: True
 
    skip_value: boolean
    Default : false, Specifies nsh script flag value is optional. Use = false and Ignore = true.
    Example: True
}

NSH Script Job Response

 TSSA nsh script job response.


{
    id: #Job Identifier *
    Job Identifier
 
    name: string*
    Name of the job.
    Example: TestJob
 
    description: string
    Description of the job.
    Example: TestJob
 
    nshscript: #NSH Script Header
    Specifies the nsh script details for which the new job needs to be created.
 
    script_execute_options: boolean*
    Execute Asynchronously (copy and execute non-nsh scripts only).
 
    log_options: boolean
    Show only script logs.
 
    script_parameters_details: [
      NSH script job parameters details.
 
       #NSH Script Job Parameter Name Value
    ]
 
    group: #Job Group *
    {{ Specifies the job group details where the new job needs to be created.}}
 
    max_parallel_targets: integer
    Default : 0, Specifies the number of target servers to process in parallel. Specify 0 to run the job in parallel on as many target servers as possible. If a decimal number is provided, then the nearest integer which is less than or equal to the number is considered.
 
    execution_override: boolean
    Default : false, This job will always execute as the user and role which schedules the job.
    Example: True
 
    targets: #Job Targets
    Specifies the servers where this job runs.
 
    notifications: #Job Run Notification
    Specifies options for defining default notifications that are generated when a job completes. If you have set up notifications for a particular scheduled job, those notifications are generated instead of default notifications.
 
    schedules: [
      Specifies the date and time when the job or phase of a job should run.
 
       #Schedule
    ]
 
    execute_now_schedule_id: integer
    Specifies the schedule ID for execute now.
 
    acl: #RBAC Access Control List
    RBAC Access Control List
}

NSH Script Parameter Details

 Detailed information about the nsh script.


{
    id: integer
    Specifies the depot object ID.
    Example: 1
 
    version_id: integer
    Specifies version of the depot object.
    Example: 1
 
    bl_value_id: integer
    Specifies the property set instance ID associated with the depot object.
    Example: 1
 
    name: string
    Specifies name of the depot object.
    Example: Name of depot object
 
    description: string
    Specifies description of the depot object.
    Example: Description of depot object
 
    file_location: string
    Specifies file location of the depot object.
    Example: //localhost/C/tmp
 
    parent_group_id: integer
    Specifies the depot object parent group ID.
    Example: 20004
 
    file_extension: string
    Specifies the extension of the file.
    Example: txt
 
    save_in: string
    Specifies the saved depot path.
    Example: Depot/TSSAObject
 
    repository_type: string
    Specifies the type of repository used to save script file.
    Example: TSSA Repository
 
    script_type_id: integer
    Specifies the script type ID.
    Example: 2
 
    object_type: #NSH script object type
    Specifies type ID of the depot object.
 
    script_type: string
    Specifies the script type name.
    Example: Execute the script once, passing the host List
 
    script_parameters_details: [
      NSH script parameters details.
 
       #NSH Script Parameter Name Value
    ]
 
    user_created: #TSSA User
    Specifies TrueSight Server Automation user information that created the depot object.
 
    role_created: #TSSA Role
    Specifies TrueSight Server Automation role information that created the depot object.
 
    user_modified: #TSSA User
    Specifies TrueSight Server Automation user information that last modified the depot object.
 
    role_modified: #TSSA Role
    Specifies TrueSight Server Automation role information that last modified the depot object.
 
    bl_acl: integer
    Specifies the access control list ID of the depot object.
    Example: 120001
 
    date_created: string
    Specifies the creation date of the depot object.
    Example: 2019-01-24 15:55:45.107
 
    date_modified: string
    Specifies the last modified date of the depot object.
    Example: 2019-01-24 15:55:45.14
 
    is_external_repository: boolean
    Specifies whether the depot object payload is stored on an external GIT repository.
}

NSH Script Parameter Name Value

 NSH script parameters name value pair.


{
    id: integer*
    Specifies ID of the parameter.
    Example: 1
 
    name: string
    Name of the parameter.
    Example: Test
 
    value: string
    Parameter value. If default value is null and editable, then this value is mandatory.
    Example: 3
 
    flag: string
    Flag for the parameter.
    Example: -test
 
    value_runtime_usage: boolean
    Flag value is required at runtime. Non-existence of this property means optional.
    Example: True
 
    flag_runtime_usage: boolean
    Flag is required at runtime. Non-existence of this property means optional.
    Example: True
 
    editable: boolean
    Flag value is editable.
    Example: True
 
    description: string
    Description for the flag.
    Example: Test flag
}

NSH script object type

 Represents object type details.


{
    id: integer
    Specifies the resource type ID in TrueSight Server Automation.
    Example: 1
 
    name: string
    Specifies the resource type name in TrueSight Server Automation.
    Example: NSH Script
}

NSHScript Job Request

 Information about creating a nsh script job with specific requirements.


{
    name: string*
    Name of the job.
    Example: TSSAJob
 
    description: string
    Description of the job.
    Example: TSSA Job
 
    nshscript: #NSH Script Header *
    Specifies the nshscript details for which the new job needs to be created.
 
    script_execute_options: boolean
    Execute Asynchronously (copy and execute non-NSH scripts only).
 
    log_options: boolean
    Show only script logs.
 
    script_parameters: [
      NSH script job parameters.
 
       #NSH Script Job Parameter Value
    ]
 
    group: #Job Group *
    {{ Specifies the job group details where the new job needs to be created.}}
 
    max_parallel_targets: integer
    Default : 0, Specifies the number of target servers to process in parallel. Specify 0 to run the job in parallel on as many target servers as possible. If a decimal number is provided, then the nearest integer which is less than or equal to the number is considered.
 
    execution_override: boolean
    Default : false, This job will always execute as the user and role which schedules the job.
    Example: True
 
    targets: #Job Targets
    Specifies the servers where this job runs.
 
    notifications: #Job Run Notification
    Specifies options for defining default notifications that are generated when a job completes. If you have set up notifications for a particular scheduled job, those notifications are generated instead of default notifications.
 
    execute_now: boolean
    Default : true, Specifies whether you want to execute the job immediately. Select false if you want to execute the job later at a scheduled time.
    Example: True
 
    schedules: [
      Specifies the date and time when the job or phase of a job should run.
 
       #Schedule
    ]
}

Notification


 Information about notification.


{
    id: integer
    {{ Specifies the system-generated unique ID for the notification. Value of this attribute will be ignored if notification is added or updated.}}
    Example: 200001
 
    value: string
    Specifies the SNMP hostnames to notify when a job completes with the status that you specify. Separate multiple SNMP hostnames with semicolons or commas.
    Example: BMCSNMPHost,TSSPSNMPHost
 
    success: boolean
    Set this option to True to send notifications in case the job is completed successfully.
    Example: True
 
    failure: boolean
    {{ Set this option to True to send notifications in case the job is not completed successfully.}}
 
    aborted: boolean
    Set this option to True to send notifications in case the job is aborted in between.
    Example: True
}

Notification URL


 Information about the notification URL parameters provided as a callback.


{
    url: string
    Specifies the URL string to be sent as part of the notification. For example, http://tssa-notification-url.bmc.com:9850/
    Example: http://tssa-notification-url.bmc.com:9850/
 
    accept: string
    Default : json, Specifies the media types which are acceptable for the response.
    Enum: [
      "xml",
      "json"
    ]
    Example: json
 
    retry_count: integer
    Default : 10, Specifies the maximum number of retry attempts of invocation of notification URL.
    Example: 10
 
    retry_pause: integer
    Default : 20 seconds, Specifies the pause duration between retry attempts.
    Example: 20
 
    retry_timeout: integer
    Default : 300 seconds, Specifies the maximum time in seconds that the system can wait for the response.
    Example: 300
}

Object Type


 Information about the type of TrueSight Server Automation object.


{
    id: integer
    Specifies the resource type ID in TrueSight Server Automation.
    Example: 5004
 
    name: string
    Specifies the name of the resource type in TrueSight Server Automation.
    Example: Server
}

Object Type Depot Software Bulletins

 Represents object type details.


{
    id: integer
    TrueSight Server Automation resource type ID.
    Example: 308
 
    name: string
    TrueSight Server Automation resource type name.
    Example: Bulletin Windows Installable
}

Object Type Depot Software Errata

 Represents object type details.


{
    id: integer
    TrueSight Server Automation resource type ID.
    Example: 305
 
    name: string
    TrueSight Server Automation resource type name.
    Example: Errata Linux Installable
}

Object Type Depot Software HotFix

 Information about resource type in TrueSight Server Automation.


{
    id: integer
    Specifies the resource type ID in TrueSight Server Automation.
    Example: 114
 
    name: string
    Specifies the name of the resource type in TrueSight Server Automation.
    Example: Hotfix Windows Installable
}

Object Type Depot Software RPM

 Represents object type details.


{
    id: integer
    TrueSight Server Automation resource type ID.
    Example: 68
 
    name: string
    TrueSight Server Automation resource type name.
    Example: RPM Linux Installable
}

Operating System Detail


 Information about the supported OS in TrueSight Server Automation.


{
    id: integer
    Specifies the OS ID in TrueSight Server Automation.
    Example: 1
 
    name: string
    Specifies the OS name in TrueSight Server Automation.
    Example: Windows
 
    nsh_name: string
    Specifies the OS NSH name in TrueSight Server Automation.
    Example: WindowsNT
}

Patch Analysis Results


 Information about the list of patch status for the specific job run of a patching job.


{
    patch_list: [
      List of patch status for provided job run of patching job.
 
       #Patch Status
    ]*
 
    total_records: integer*
    The number of records that match the search criteria.
    Example: 1203
}

Patch Analysis Summary


 Information about the patch analysis summary.


{
    id: integer*
    Specifies the analysis job run ID for the job.
 
    patches: #Patch Artifact Summary
    Patch summary
 
    containers: #Patch Artifact Summary
    Patch containers
 
    scanned_machines: integer
    Total number of machines for which scanning is completed.
 
    not_scanned_machines: integer
    Total number of machines for which scanning is not completed.
}

Patch Artifact Summary


 Information about the summary of patch artifact for a particular patching job run.


{
    type: #Resource Type
    TSSA depot object type of patch artifact.
 
    missing: integer
    Specifies missing count of patch artifact.
    Example: 8
 
    installed: integer
    Specifies installed count of patch artifact.
    Example: 45
}

Patch Container Details


 Information about the response containing list of containers.


{
    bulletin: #Windows Bulletin
    Bulletin definition will be returned in case of windows patch catalog.
 
    errata: #Depot Software Errata
    Errata definition will be returned in case of redhat patch catalog.
}

Patch Containers


 Information about the list of all containers in the catalog.


{
    _links: [
       #Link
    ]
    patch_containers: [
      List of patch containers matching current criteria.
 
       #Patch Container Details
    ]
 
    total_records: integer
    Number of patch containers in the catalog matching current criteria.
    Example: 12
}

Patch List


 Information about the response containing list of patches.


{
    hotfix: #Depot Software Hotfix
    Hotfix definition will be returned in case of windows patch catalog
 
    rpms: #Depot Software RPMs
    RPM definition will be returned in case of redhat patch catalog
}

Patch Remediation Results


 Information about the patch remediation status categorized per server.


{
    list: [
      List of patch remediation status.
 
       #Remediation Status
    ]*
 
    total_records: integer*
    The number of records that match the search criteria.
    Example: 1203
}

Patch Result Status


 Information about patch result status.


{
    object_type: #Resource Type
    Type identifier and name of patch (Hotfix, RPMs etc) or container (Bulletin, Errata etc).
 
    status: string
    Specify the status of the catalog patch result item.
    Enum: [
      "Unknown",
      "Added",
      "Updated",
      "Obsoleted",
      "Failed",
      "Downloaded",
      "Failed To Download",
      "Missing",
      "Installed",
      "Not Applicable",
      "Invalid Url",
      "Effectively Installed",
      "Missing SP"
    ]
    Example: Installed
 
    total_count: integer
    Specify the total number of the catalog patch result items.
    Example: 23
}

Patch Status


 Information about the list of patch status for a specific job run of a patching job.


{
    server_id: integer*
    Specifies the server ID on which patching job is executed.
 
    server_name: string*
    Specifies the server name on which patching job is executed.
 
    patch_id: integer*
    Specifies the patch ID of the analyzed patch.
 
    patch_type: #Resource Type *
    Specifies the patch type of the analyzed patch.
 
    patch_name: string*
    Specifies the patch name of the analyzed patch.
 
    parent_container_id: integer
    Specifies the identifier of the container of the analyzed patch.
 
    patch_status: string
    Specifies the patch status of the analyzed patch.
    Enum: [
      "UNKNOWN",
      "ADDED",
      "UPDATED",
      "OBSOLETED",
      "FAILED",
      "DOWNLOADED",
      "FAILED_TO_DOWNLOAD",
      "MISSING",
      "INSTALLED",
      "NOT_APPLICABLE",
      "INVALID_URL",
      "EFFECTIVELY_INSTALLED",
      "MISSING_SP"
    ]
}

Patch analysis options


 Information about the different patch analysis options.


{
    windows: #Windows Patch Analysis Options
    Windows patch analysis options.
 
    redhat: #Redhat Patch Analysis Options
    Redhat patch analysis options.
}

Patch deploy summary


 Information about the summary of deploy results for a specific patching job run.


{
    all: integer
    Total number of targets for which patch deploy job has executed.
 
    failed: integer
    Total number of targets for which patch deploy job has failed.
 
    not_started: integer
    Total number of targets for which patch deploy job has not started.
 
    paused: integer
    Total number of targets for which patch deploy job has paused.
 
    pending_reboot: integer
    Total number of pending reboot targets.
 
    pending_targets: integer
    Total number of pending targets.
 
    running_targets: integer
    Total number of running targets.
 
    successful_targets: integer
    Total number of successful targets.
 
    success_with_warnings: integer
    Total number of targets that have succeeded with warnings.
}

Patch download summary


 Information about the summary of patch download for a specific patching job run.


{
    skipped: integer
    Total number of downloads skipped due to an invalid URL.
 
    failed: integer
    Total number of failed downloads.
 
    successful: integer
    Total number of successful downloads.
}

Patch product


 Information about a patch product.


{
    id: integer
    Specifies the patch ID.
    Example: 2000003
 
    name: string
    Specifies the name of software type.
    Example: WINDOWS SERVER 2012 R2 DATACENTER (X64)
}

Patch remediation artifacts


 Information about the patch remediation options used to remediate on completion of analysis.


{
    artifact_prefix: string*
    Specify a text that the patching job automatically adds to the name of all BLPackages and deploy jobs created. By default, the name of the patching job appears in this field.
    Example: WindowsPatchingJob
 
    depot_group: #Depot Group *
    Specify a depot location where the remediation package is stored. By default, the location is the same one used to store the Patching Job.
 
    job_group: #Job Group *
    Enter the folder where the Remediation and deploy jobs created by the patching job are stored. By default, the location is the same one used to store the patching job.
 
    acl_policy_id: integer
    Specifies the ACL policy to assign to each BLPackage, deploy job, and batch job created by the patching job. To delete an existing policy, set it to 0.
    Example: 101010
 
    remediation_options: #Patch remediation options
    Remediation deploy job Options.
}

Patch remediation options


 Information about the patch remediation deploy job options.


{
    template_job: #Job Identifier
    Template Deploy Job Identifier. Not supported in current release.
 
    options: #Deploy Job Options
    Deploy Job Options for Patch remediation.
}

Patch remediation result summary


 Information about the summary of remediation results for a specific patching job run.


{
    deploy: #Patch deploy summary
    Patch deploy summary.
 
    download: #Patch download summary
    Patch download summary.
 
    id: integer*
    Specifies the remediation job run ID.
}

Patching Job Create Request


 Information about the details required to create a patching job.


{
    name: string*
    Name of the patching job.
    Example: WindowsPatchingJob
 
    description: string
    Description of the patching job.
    Example: Windows Patching Job
 
    group: #Job Group *
    {{ Specifies the job group details where the new job needs to be created.}}
 
    catalog: #Depot Group *
    Specifies the catalog details for which the new job needs to be created.
 
    max_parallel_targets: integer
    Default : 0, Specifies the number of target servers to process in parallel. Specify 0 to run the job in parallel on as many target servers as possible. If a decimal number is provided, then the nearest integer which is less than or equal to the number is considered.
 
    execution_override: boolean
    Default : false, This job will always execute as the user and role which schedules the job.
    Example: True
 
    analysis: #Patch analysis options
    Specifies the different patch analysis options.
 
    remediation: #Patch remediation artifacts
    Specifies the patch remediation options used to remediate on completion of analysis
 
    targets: #Job Targets
    Specifies the servers where this job runs.
 
    notifications: #Job Run Notification
    Specifies options for defining default notifications that are generated when a job completes. If you have set up notifications for a particular scheduled job, those notifications are generated instead of default notifications.
 
    execute_now: boolean
    Patching Job will be executed now.
    Example: True
 
    schedules: [
      Specifies the date and time when the job or phase of a job should run.
 
       #Schedule
    ]
}

Patching Job Request


 Information about creating a patching job with specific requirements.


{
    name: string*
    Name of the patching job.
    Example: WindowsPatchingJob
 
    description: string
    Description of the patching job.
    Example: Windows Patching Job
 
    group: #Job Group *
    {{ Specifies the job group details where the new job needs to be created.}}
 
    catalog: #Depot Group *
    Specifies the catalog details for which the new job needs to be created.
 
    max_parallel_targets: integer
    Default : 0, Specifies the number of target servers to process in parallel. Specify 0 to run the job in parallel on as many target servers as possible. If a decimal number is provided, then the nearest integer which is less than or equal to the number is considered.
 
    execution_override: boolean
    Default : false, This job will always execute as the user and role which schedules the job.
    Example: True
 
    analysis: #Patch analysis options
    Specifies the different patch analysis options.
 
    remediation: #Patch remediation artifacts
    Specifies the patch remediation options used to remediate on completion of analysis
 
    targets: #Job Targets
    Specifies the servers where this job runs.
 
    notifications: #Job Run Notification
    Specifies options for defining default notifications that are generated when a job completes. If you have set up notifications for a particular scheduled job, those notifications are generated instead of default notifications.
 
    execute_now: boolean
    Default : true, Specifies whether you want to execute the job immediately. Select false if you want to execute the job later at a scheduled time.
    Example: True
 
    schedules: [
      Specifies the date and time when the job or phase of a job should run.
 
       #Schedule
    ]
}

Patching Job Response


 Information about patching job response.


{
    id: #Job Identifier *
    Job Identifier
 
    name: string*
    Name of the patching job.
    Example: WindowsPatchingJob
 
    description: string
    Description of the patching job.
    Example: Windows Patching Job
 
    group: #Job Group *
    {{ Specifies the job group details where the new job needs to be created.}}
 
    catalog: #Depot Group *
    Specifies the catalog details for which the new job needs to be created.
 
    max_parallel_targets: integer
    Default : 0, Specifies the number of target servers to process in parallel. Specify 0 to run the job in parallel on as many target servers as possible. If a decimal number is provided, then the nearest integer which is less than or equal to the number is considered.
 
    execution_override: boolean
    Default : false, This job will always execute as the user and role which schedules the job.
    Example: True
 
    analysis: #Patch analysis options
    Specifies the different patch analysis options.
 
    remediation: #Patch remediation artifacts
    Specifies the patch remediation options used to remediate on completion of analysis
 
    targets: #Job Targets
    Specifies the servers where this job runs.
 
    notifications: #Job Run Notification
    Specifies options for defining default notifications that are generated when a job completes. If you have set up notifications for a particular scheduled job, those notifications are generated instead of default notifications.
 
    execute_now: boolean
    Patching Job will be executed now.
    Example: True
 
    schedules: [
      Specifies the date and time when the job or phase of a job should run.
 
       #Schedule
    ]
 
    execute_now_schedule_id: integer
    Specifies the schedule ID for execute now.
 
    acl: #RBAC Access Control List
    RBAC Access Control List
}

Patching Job Runs


 Information about patch job runs.


{
    job_run: #Job Run Identifier
    Identifier of the jobRun
 
    job: #Job Identifier
    Identifier of the job
 
    role_executed: #TSSA Role
    Details of the role that execute this job
 
    user_executed: #TSSA User
    Details of the user who execute this job
 
    start_time: string
    Specifies the start time of the job execution.
    Example: 2019-03-12 15:41:03.837
 
    end_time: string
    Specifies the end time of the job execution.
    Example: 2019-03-12 15:41:31.297
 
    progress_status: string
    Specifies the status of the progress of the job execution.
    Enum: [
      "not_started",
      "running",
      "incomplete",
      "complete",
      "paused",
      "resuming",
      "aborted"
    ]
    Example: complete
 
    object_type: #TSSA Resource
    Type of Job executed
 
    has_errors: boolean
    Specifies if the job execution has any errors.
 
    has_warnings: boolean
    Specifies if the job execution has any warnings.
 
    is_cancelled: boolean
    Specifies if the job execution is cancelled.
 
    is_reset: boolean
    Specifies if the job execution is reset to be executed again.
 
    is_reboot: boolean
    Specifies if the job is waiting for a target server to be rebooted.
 
    schedule_id: integer
    Specifies the schedule ID.
    Example: 2
 
    analysis_job_run: #Job Run Details
    Specifies the patching analysis job execution run for the current job
 
    remediation_job_runs: [
      Specifies the patching remediation job execution run for the current job
 
       #Remediation Job Run
    ]
}

Patching job result summary


 Information about the summary of a specific patching job run result.


{
    id: integer*
    {{ Specifies the job run ID for the job.}}
 
    analysis: #Patch Analysis Summary *
    Patching analysis summary
 
    remediation: [
      Patching remediation summary
 
       #Patch remediation result summary
    ]
}

Phase options


 Information about different phases for deploy job.


{
    disk_space_check: string
    Default : no_check, Instructs the deploy job to check if sufficient disk space exists on a target server in the selected phase.
    Enum: [
      "no_check",
      "stage",
      "simulate",
      "both"
    ]
 
    auto_rollback: boolean
    Default : true or value set in DeployOptions.IS_AUTO_ROLLBACK property. When you set this option to True and the Commit phase fails for any reason, the deploy job is automatically rolled back, leaving the destination host unchanged. If you set this option to false and the Commit phase fails, the deployment aborts and does not roll back any transactions that are part of the deployment.
 
    allow_rollback: boolean
    {{ Default : true or value set in DeployOptions.IS_ALLOW_ROLLBACK property. Set this option to true to instruct the deploy job to leave rollback files on the target server so they can be used later. In some situations, the rollback files left on the target server can be very large.}}
 
    preserve_staging_on_failure: boolean
    Default : false or value set in DeployOptions.PRESERVE_STAGING_DIR_ON_FAILURE property. Set this option to true to retain data copied to a staging area on a target server even though the deploy job fails. By default, a deploy job deletes the staging directory on a target server when a failure occurs during any phase of the job. Preserving a staging area can potentially leave large files on a target directory after job failure. This option is useful for debugging the failure.
 
    overwrite_read_only_files: boolean
    {{ Default : false, or value set in DeployOptions.OVERWRITE_READONLY_FILES property.}}
 
    ignore_copy_on_boot: boolean
    Default : true or value set in DeployOptions.IGNORE_COPY_ON_BOOT_FILES property. Set this option to true to instruct a server to begin the Commit phase of the deploy job even though a server requires a reboot to copy over existing locked files. Entering false means the Commit phase does not begin if locked files requiring a reboot exist.
 
    copy_locked_files: boolean
    (Applicable to Microsoft Windows target systems only.) Default : false or value set in DeployOptions.COPY_LOCKED_FILES property. Set this option to true to instruct a target server to create "copy on boot" files when locked files are encountered during the Commit phase of a deploy job. Entering False means the job generates an error and fails if it encounters locked files.
 
    com: #Windows COM settings
    (Applicable to Microsoft Windows target systems only.) Depending on the extension of the file (DLL, EXE, or OCX), the job determines whether the file is a COM object.
}

RBAC Access Control Entry


 Information about the model containing role and corresponding permission.


{
    role_id: integer
    Specifies the role ID in TrueSight Server Automation.
    Example: 1000001
 
    role_name: string
    Specifies the role name in TrueSight Server Automation.
    Example: BLAdmins
 
    authorization_id: integer
    Specifies the permission ID in TrueSight Server Automation.
    Example: 1000003
 
    authorization_name: string
    Specifies the permission name in TrueSight Server Automation.
    Example: PatchingJob.Read
}

RBAC Access Control List


 Information about the model containing list of access control entry.


{
    acl_id: integer
    Specifies the role ID in TrueSight Server Automation.
 
    aces: [
      List of access control entries
 
       #RBAC Access Control Entry
    ]
 
    acl_policies: [
      List of access policies
 
       #RBAC Policy for Access Control List
    ]
}

RBAC Policy for Access Control List


 Information about the model containing policies for list of access control entry.


{
    acl_policy_id: integer
    Specifies ACL policy ID.
 
    aces: [
      List of access control entries
 
       #RBAC Access Control Entry
    ]
}

RSCD Agent Version Detail


 Information about the RSCD agent version of TrueSight Server Automation.


{
    major_version: integer
    Specifies RSCD agent major version.
    Example: 8
 
    minor_version: integer
    Specifies RSCD agent minor version.
    Example: 9
 
    patch_version: integer
    Specifies RSCD agent patch version.
    Example: 4
 
    build_version: integer
    Specifies RSCD agent build version.
    Example: 112
}

Redhat Patch Analysis Options


 Information about Redhat patch analysis options.


{
    mode: string
    Default : 'Update Mode', Specifies whether you want to analyze for missing RPMs and updates available for installed RPMs on a target server (Install Mode) or analyze only for updates available for installed RPMs on a target server (Update Mode).
    Enum: [
      "update",
      "install"
    ]
 
    package_name_options: string
    Default : 'By_Complete_Package_Name', Specifies the package name options for analysis. The options are : By_Complete_Package_Name or By_Package_Name_only.
    Enum: [
      "By_Complete_Package_Name",
      "By_Package_Name_only"
    ]
 
    list: #Include Exclude List for patches and patch groups
    List of patches.
}

Remediation Job Run


 Information about patch remediation job runs.


{
    job_run: #Job Run Identifier
    Identifier of the jobRun
 
    job: #Job Identifier
    Identifier of the job
 
    role_executed: #TSSA Role
    Details of the role that execute this job
 
    user_executed: #TSSA User
    Details of the user who execute this job
 
    start_time: string
    Specifies the start time of the job execution.
    Example: 2019-03-12 15:41:03.837
 
    end_time: string
    Specifies the end time of the job execution.
    Example: 2019-03-12 15:41:31.297
 
    progress_status: string
    Specifies the status of the progress of the job execution.
    Enum: [
      "not_started",
      "running",
      "incomplete",
      "complete",
      "paused",
      "resuming",
      "aborted"
    ]
    Example: complete
 
    object_type: #TSSA Resource
    Type of Job executed
 
    has_errors: boolean
    Specifies if the job execution has any errors.
 
    has_warnings: boolean
    Specifies if the job execution has any warnings.
 
    is_cancelled: boolean
    Specifies if the job execution is cancelled.
 
    is_reset: boolean
    Specifies if the job execution is reset to be executed again.
 
    is_reboot: boolean
    Specifies if the job is waiting for a target server to be rebooted.
 
    schedule_id: integer
    Specifies the schedule ID.
    Example: 2
 
    download_job_run: #Job Run Details
    Specifies the download job execution run for the current job
 
    deploy_job_runs: [
      Specifies the deploy job run for the current job
 
       #Child Deploy Job Runs list
    ]
}

Remediation Status


 Information about patch remediation status on the server.


{
    job_run: #Job Run Identifier *
    Specifies the job run ID for the job.
 
    deploy_job_run: #Job Run Identifier *
    Specifies the job run ID for the deploy job.
 
    deploy_job_result_id: integer*
    Specifies the result ID for the deploy job.
 
    server: #Servers *
    Specifies the Server Identifier
 
    progress_status: string*
    {{ Specifies the status of the job run.}}
    Enum: [
      "not_started",
      "running",
      "incomplete",
      "complete",
      "paused",
      "resuming",
      "aborted"
    ]
    Example: complete
 
    exit_code: integer*
    Specifies the exit code of the job run.
 
    error_code: string*
    {{ Specifies the error code of the job run, if any.}}
 
    start_date_time: string*
    Specifies the start time of the job execution.
    Example: 2019-03-13 15:48:29.813
 
    end_date_time: string*
    Specifies the start time of the job execution.
    Example: 2019-03-13 15:50:33.98
 
    is_errors: boolean*
    This field is set to true if the job has failed on specified server.
 
    reboot_required: boolean*
    This field is set to true if the job server is marked for a manual restart.
    Example: True
}

Resource Type


 Information about resource type in TrueSight Server Automation.


{
    id: integer
    Specifies the resource type ID in TrueSight Server Automation.
    Example: 114
 
    name: string
    Specifies the name of the resource type in TrueSight Server Automation.
    Example: Hotfix Windows Installable
}

Role detail


 Information about the list of all roles.


{
    roles: [
      Specifies the role details.
 
       #TSSA Role Bean
    ]
 
    total_records: integer
    The number of records that match the search criteria.
    Example: 12
}

Schedule


 Information about the job schedule. The schedule option can be one of the following types: 'once', 'weekly', 'daily', 'monthly', 'interval'. If you provide more than one scheduling option, 'daily' is selected.


{
    id: integer
    Specifies the ID of the existing schedule for updating or deleting a schedule. Value of this attribute will be ignored if the schedule is created.
 
    once: #Schedule Once
    Specifies one-time scheduling of the job.
 
    daily: #Schedule Daily
    Specifies a recurring daily schedule, for the job to run at a set time once a day.
 
    weekly: #Schedule Weekly
    Specifies a recurring schedule based on days of the week.
 
    monthly: #Schedule Monthly
    Specifies a recurring schedule based on a day of the month.
 
    interval: #Schedule Interval
    Specifies a recurring schedule based on a time interval that you define.
 
    timezone: string
    Specifies the time zone in which the job should run. The time includes the job's time zone relative to Greenwich Mean Time. For a recurring schedule, the system automatically accounts for differences in time zones and changes in daylight savings time. For example, if you schedule a job that should run weekly at 06:00 Eastern Standard Time, the job always runs at 06:00 Eastern Time, no matter whether standard or daylight savings time is in effect.
    Example: Asia/Calcutta
 
    priority: string
    Specifies an execution priority level. The options are: Critical, High, Normal, Low, and Lowest.
    Enum: [
      "CRITICAL",
      "HIGH",
      "NORMAL",
      "LOW",
      "LOWEST"
    ]
 
    notifications: #Job Run Notification
    Specifies options for defining default notifications that are generated when a job completes. If you have set up notifications for a particular scheduled job, those notifications are generated instead of default notifications.
 
    approval: #Approval Request
    Specifies the details of the approval request of the schedules.
}

Schedule Daily


 Information about the daily job schedule.


{
    time: string
    {{ Specifies the time for the schedule in 24-hour clock format (00:00 to 23:59).}}
    Example: 10:15
}

Schedule ID


 Information about schedule id for which operation is executed.


{
    schedule_id: integer
    Schedule Id for which operation is executed
    Example: 1
}

Schedule Interval


 Information about job interval schedule including start time and frequency.


{
    start_date_time: string
    {{ Specifies the start time of interval in "YYYY-MM-DD HH:MM:SS" format. For example, 2019-07-24 20:00:00}}
    Example: 2019-07-24 20:00:00
 
    frequency: #Schedule Interval Frequency
    Specifies the job interval schedule frequency in terms of days, hours, and minutes. Enter the interval (number of days + hours + minutes) for subsequent occurrences.
}

Schedule Interval Frequency


 Information about job interval schedule frequency in terms of days, hours, and minutes.


{
    days: integer
    Specifies the days in the interval.
    Example: 1
 
    hours: integer
    Specifies the hours in the interval.
    Example: 12
 
    minutes: integer
    Specifies the minutes in the interval.
    Example: 60
}

Schedule Monthly


 Information about the monthly job schedule. It can be scheduled for the following days: 1) Any weekday of a month 2) A particular day of a month 3) Last day of a month.


{
    week: #Week of Month
    Specifies the particular weekday out of possible weeks in month.
 
    day_of_month: integer
    Specifies a particular day number of every month when the job should execute.
    Example: 29
 
    is_last_of_month: boolean
    Specifies whether to execute the job on the last day of every month.
    Example: True
 
    time: string
    Specifies the time for the schedule in 24-hour clock format (00:00 to 23:59).
    Example: 10:15
}

Schedule Once


 Information about the job schedule to be executed once.


{
    datetime: string*
    Specifies the date for the schedule in "YYYY-MM-DD HH:MM:SS" format. For example, 2019-07-24 20:00:00
    Example: 2019-07-24 20:00:00
}

Schedule Weekly


 Information about weekly job schedule.


{
    time: string
    Specifies the time for the schedule in 24-hour clock format (00:00 to 23:59).
    Example: 10:15
 
    frequency: integer
    Specifies the weekly interval of the job. For example, enter 3 if the job should occur every three weeks.
    Example: 1
 
    days: [
      Specifies the days of the week when the job should execute. You can select multiple days.
 
      string
      Enum: [
        "Sunday",
        "Monday",
        "Tuesday",
        "Wednesday",
        "Thursday",
        "Friday",
        "Saturday"
      ]
    ]
}

Schedule options


 Information about schedule options.


{
    simulate: boolean
    Default : true or value set in DeployOptions.IS_SIMULATE_ENABLED property, Set this option to true to enable the Simulate phase of the deploy job. The Simulate phase performs a dry run of deployment without actually deploying a package.
 
    commit: boolean
    Default : true or value set in DeployOptions.IS_COMMIT_ENABLED property, Set this option to true to enable the Commit phase of the deploy job. During the Commit phase, packages are applied to target servers.
 
    staging: string
    Default : 'direct' or value set in DeployOptions.IS_STAGING_INDIRECT property, Set this option to true to enable indirect staging, which means the deploy job delivers the package to a repeater. During the Commit phase, the package is applied to the target server. Entering False means the job delivers the package directly to a target server.
    Enum: [
      "direct",
      "indirect"
    ]
 
    execute_job_now: boolean
    Default : false, Specifies whether you want to execute the job immediately or to a later time.
 
    schedule_details: #Deploy schedule settings
    Specifies the date and time when the deploy job should run.
}

Server Details


 Detailed information about the server.


{
    _links: [
       #Link
    ]
    server: #Server Response
    Specifies the server details.
 
    properties: {
      Specifies the server properties.
    }
}

Server Group Definition


 Information about the server group.


{
    id: integer
    Specifies the ID of the server group.
    Example: 1000001
 
    path: string
    Specifies the absolute path of the server group.
    Example: /windows_servers
}

Server List


 Information about TrueSight Server Automation servers.


{
    _links: [
       #Link
    ]
    server_list: [
      List of servers
 
       #Server Response
    ]
 
    total_records: integer
    The number of records that match the search criteria.
    Example: 23
}

Server Response


 Information about the server definition.


{
    id: integer
    Specifies the server ID.
    Example: 1
 
    guid: string
    Specifies the unique GUID of the server.
    Example: 0x8E06317B73E044A9B42F780A13EF9FEA
 
    name: string
    Specifies the server name.
    Example: localhost
 
    description: string
    Specifies the server description.
 
    ip_address: string
    Specifies IP address of the server.
    Example: 127.0.0.1
 
    os: #Operating System Detail
    Specifies the operating system of the server.
 
    os_release: string
    Specifies the operating system release of the server.
    Example: 10.0
 
    os_vendor: string
    Specifies the operating system vendor of the server.
    Example: Microsoft
 
    os_version: string
    Specifies the operating system version of the server.
    Example: 10
 
    build_environment: string
    Specifies build environment of the server.
    Example: Windows2003-x86_64
 
    agent_version: #RSCD Agent Version Detail
    Specifies TrueSight Server Automation RSCD agent version in the server.
 
    ip_address_in_use: boolean
    Specifies whether the IP address is in use.
    Example: True
 
    subnet_mask: string
    specifies the subnet mask set on the server.
    Example: 255.255.240.0
 
    pm_device_id: integer
    Specifies the device ID
 
    device_type: #Device Type
    Specifies the device type details.
 
    device_state: #Device State
    Specifies state of the server.
 
    agent_state: #Agent State
    Specifies state of the installed TSSA Agent.
 
    agent_platform: #Agent Platform
    Platform of the TrueSight Server Automation RSCD Agent.
 
    is_repeater: boolean
    Specifies whether this RSCD agent is a TrueSight Server Automation repeater.
 
    repeater_name: string
    Name of the repeater assigned to this server.
    Example: some.repeater.com
 
    repeater_staging_directory: string
    If the value of is_repeater is true, then this field specifies the staging location that can be used by the server.
    Example: /repeater/stage
 
    repeater_cache_max_size: integer
    Specifies the maximum size of repeater cache.
    Example: 1024
 
    staging_directory: string
    Specifies the staging directory location on the server.
    Example: /tmp/stage
 
    date_created: string
    Specifies the date when the server was created.
    Example: 2018-11-05 09:10:36.703
 
    date_modified: string
    Specifies the date when the server was modified.
    Example: 2018-11-05 09:14:57.333
 
    role_created: #TSSA Role
    Specifies the role details who created the server details in TrueSight Server Automation.
 
    role_modified: #TSSA Role
    Specifies the role details who modified the server details in TrueSight Server Automation.
 
    user_created: #TSSA User
    Specifies the user details who created the server details in TrueSight Server Automation.
 
    user_modified: #TSSA User
    {{ Specifies the user details who modified the server details in TrueSight Server Automation.}}
 
    acl_id: integer
    Specifies the ID for RBAC Access Control List.
 
    acl: #RBAC Access Control List
    RBAC Access Control List.
}

Server patch status

 Patch status per servers.


{
    id: integer
    Specifies server identifer
    Example: 1
 
    name: string
    Specifies server name
    Example: localhost
 
    missing_patch_count: integer
    Total number of missing patches
    Example: 26
 
    installed_patch_count: integer
    Total number of installed patches
    Example: 195
 
    missing_container_count: integer
    Total number of missing containers
    Example: 5
 
    installed_container_count: integer
    Total number of installed containers
    Example: 73
}

Servers


 Information about the server group.


{
    id: integer
    Specifies the server ID.
    Example: 1
 
    name: string
    Specifies the server name.
    Example: localhost
}

Service Pack


 Information about the service pack definition.


{
    id: integer
    Specifies the ID of service pack.
    Example: 3
 
    name: string
    Specifies the name of service pack.
    Example: SP1
}

Session Request


 Information about the detail required to create a new session.


{
    user_name: string
    Specifies the TrueSight Server Automation username as per the authentication_type property.
    Example: BLAdmin
 
    password: string
    Specifies the password of the TrueSight Server Automation user.
 
    role_name: string
    Specifies the TrueSight Server Automation role name.
    Example: BLAdmins
 
    authentication_type: string
    Specifies the authentication type.
    Enum: [
      "SRP",
      "ADK_PASSWORD"
    ]
    Example: SRP
}

Session Response


 Information about the new session.


{
    _links: [
       #Link
    ]
    session_id: string
    Specifies the session ID that will be used for validation of subsequent API calls.
    Example: 4c11beb3-4033-41f5-8e73-d61ca35c4c84
 
    roles: [
      Specifies the list of roles associated with the user.
 
      string
    ]
 
    expiration_time: date-time
    Specifies expiration time for the session ID.
    Example: 2019-01-16T19:39:01.764+0000
 
    default_role: string
    Specifies default role assumed for the user.
    Example: BLAdmins
 
    service_ticket: string
    Specifies a service ticket for the session ID.
}

Smart Group


 Information about the smart group basic details and its immediate parent.


{
    id: integer
    Specifies the group ID.
    Example: 2000000
 
    name: string
    Specifies the group name.
    Example: TestGroup
 
    path: string
    Specifies absolute path of the group.
    Example: /All Servers
 
    description: string
    Specifies description for the group created.
    Example: Server Smart Group
 
    parent: #Group
    Specifies parent details of the smart group.
}

Smart Group List


 Information about list of all smart groups.


{
    _links: [
       #Link
    ]
    smart_groups: [
      Specifies the smart group details.
 
       #Smart Group
    ]
 
    total_records: integer
    The number of records that match the search criteria.
    Example: 12
}

Smart group children

 Information about the list of children under smart group


{
    children: [
      Specifies the immediate children of the smart group.
 
      #Generic Object Type
    ]
 
    total_records: integer
    {{The number of immediate children under the smart group }}
    Example: 12
}

Static group children

 Information about the list of children under static group


{
    children: [
      Specifies the immediate children of the static group.
 
       #Generic Object Type
    ]
 
    total_records: integer
    {{The number of immediate children under the static group }}
    Example: 12
}

TSSA Job Results Device list

 Click here to expand...


{
    list: [
      List of all job results of target server that match the search criteria.
 
       #Device Result
    ]
 
    total_records: integer
    Number of job results of target servers that match current search criteria.
    Example: 1
}

TSSA Job Runs list


 Information about TrueSight Server Automation job runs.


{
    job_runs: [
      List of all job runs that match the search criteria.
 
       #Job Run Details
    ]
 
    total_records: integer
    Number of job runs that match current search criteria
    Example: 1
}

TSSA NSH script list

 Information about TrueSight Server Automation NSH script.


{
    nsh_scripts: [
      List of all NSH scripts that match the search criteria.
 
       #NSH Script Details
    ]
 
    total_records: integer
    Number of job runs that match current search criteria
    Example: 1
}

TSSA Resource


 Information about TrueSight Server Automation resource type.


{
    id: integer
    Specifies the object ID in TrueSight Server Automation.
    Example: 7009
 
    name: string
    Specifies the object name in TrueSight Server Automation.
    Example: Windows Patching job
}

TSSA Role


 Information about TrueSight Server Automation role ID and name.


{
    id: integer
    Specifies the role ID in TrueSight Server Automation.
    Example: 2000000
 
    name: string
    Specifies the role name in TrueSight Server Automation.
    Example: Patching Admins
}

TSSA Role Bean


 Detailed information about TrueSight Server Automation role.


{
    id: integer
    Specifies the role ID in TrueSight Server Automation.
    Example: 2000000
 
    name: string
    Specifies the role name in TrueSight Server Automation.
    Example: BLAdmins
 
    description: string
    Specifies the role description in TrueSight Server Automation.
    Example: Administrative user for TSSA
 
    is_enabled: boolean
    Specified whether the role is enabled.
    Example: True
 
    date_created: string
    Specifies the date when the role was created.
    Example: Mon Mar 25 17:12:00 IST 2019
 
    date_modified: string
    Specifies the date when the role was modified.
    Example: Mon Mar 25 17:12:00 IST 2019
 
    created_by_role: #TSSA Role
    {{ Specifies the role details who created the mentioned role in TrueSight Server Automation.}}
 
    created_by_user: #TSSA User
    Specifies the user details who created the mentioned role in TrueSight Server Automation.
 
    modified_by_role: #TSSA Role
    Specifies the role details who modified the mentioned role in TrueSight Server Automation.
 
    modified_by_user: #TSSA User
    {{ Specifies the user details who modified the mentioned role in TrueSight Server Automation.}}
}

TSSA User


 Information about TrueSight Server Automation user ID and name.


{
    id: integer
    Specifies the user ID in TrueSight Server Automation.
    Example: 2000000
 
    name: string
    Specifies the user name in TrueSight Server Automation.
    Example: Patching Administrator
}

Update Schedule Request


 Information about details required to create, update, or delete schedules.


{
    schedules: [
      List of schedules
 
       #Schedule
    ]
}

Week of Month


 Information about a specific day.


{
    week_of_month: string
    Specifies the week of the month when the job should execute.
    Enum: [
      "First",
      "Second",
      "Third",
      "Fourth",
      "Last"
    ]
    Example: First
 
    week_day: string
    Specifies the day of the week when the job should execute in that particular week.
    Enum: [
      "Sunday",
      "Monday",
      "Tuesday",
      "Wednesday",
      "Thursday",
      "Friday",
      "Saturday"
    ]
    Example: Monday
}

Windows Bulletin


 Information about Windows bulletins for depot software.



{
    <span style="color: blue"><code>id:</code></span> <span style="color: green">integer</span>
    Specifies the depot object ID.
    Example: 1
 
    <span style="color: blue"><code>version_id:</code></span> <span style="color: green">integer</span>
    Specifies version of the depot object.
    Example: 1
 
    <span style="color: blue"><code>bl_value_id:</code></span> <span style="color: green">integer</span>
    Specifies the property set instance ID associated with the depot object.
    Example: 1
 
    <span style="color: blue"><code>name:</code></span> <span style="color: green">string</span>
    Specifies name of the depot object.
    Example: Name of depot object
 
    <span style="color: blue"><code>description:</code></span> <span style="color: green">string</span>
    Specifies description of the depot object.
    Example: Description of depot object
 
    <span style="color: blue"><code>parent_group_id:</code></span> <span style="color: green">integer</span>
    Specifies the depot object parent group ID.
    Example: 20004
 
    <span style="color: blue"><code>object_type:</code></span> Object Type
    Specifies type ID of the depot object.
 
    <span style="color: blue"><code>user_created:</code></span> TSSA User
    Specifies TrueSight Server Automation user information that created the depot object.
 
    <span style="color: blue"><code>role_created:</code></span> TSSA Role
    Specifies TrueSight Server Automation role information that created the depot object.
 
    <span style="color: blue"><code>user_modified:</code></span> TSSA User
    Specifies TrueSight Server Automation user information that last modified the depot object.
 
    <span style="color: blue"><code>role_modified:</code></span> TSSA Role
    Specifies TrueSight Server Automation role information that last modified the depot object.
 
    <span style="color: blue"><code>bl_acl:</code></span> <span style="color: green">integer</span>
    Specifies the access control list ID of the depot object.
    Example: 120001
 
    <span style="color: blue"><code>date_created:</code></span> <span style="color: green">string</span>
    Specifies the creation date of the depot object.
    Example: 2019-01-24 15:55:45.107
 
    <span style="color: blue"><code>date_modified:</code></span> <span style="color: green">string</span>
    Specifies the last modified date of the depot object.
    Example: 2019-01-24 15:55:45.14
 
    <span style="color: blue"><code>is_external_repository:</code></span> <span style="color: green">boolean</span>
    Specifies whether the depot object payload is stored on an external GIT repository.
 
    <span style="color: blue"><code>software_type:</code></span> Depot Software Type
    Specifies type of the depot software.
 
    <span style="color: blue"><code>os:</code></span> Operating System Detail
    Specifies associated OS information for the depot software.
 
    <span style="color: blue"><code>install_command:</code></span> <span style="color: green">string</span>
    Specifies installation command line for the software.
    Example: "SOURCE" -q -z
 
    <span style="color: blue"><code>uninstall_command:</code></span> <span style="color: green">string</span>
    Specifies uninstallation command line for the software.
    Example: "WINDIR\\$NTUninstall??HOTFIXNAME??$\\spuninst
spuninst.exe" /u /q /z

 
    <span style="color: blue"><code>bulletin_id:</code></span> <span style="color: green">string</span>
    Specifies the bulletin ID.
    Example: CR16-001
 
    <span style="color: blue"><code>vendor_name:</code></span> <span style="color: green">string</span>
    Specifies vendor name of the bulletin.
    Example: Microsoft
 
    <span style="color: blue"><code>patch_type:</code></span> <span style="color: green">string</span>
    Specifies the patch type as defined by the vendor.
    Enum: [
      "microsoft_security_patch",
      "non_mircosoft_security_patch",
      "software_distribution",
      "security_tools",
      "non_security_patch"
    ]
    Example: software_distribution
 
    <span style="color: blue"><code>kb_url:</code></span> <span style="color: green">string</span>
    Specifies the URL to Knowledge Base (KB) article.
    Example: https://technet.microsoft.com/en-us/library/security/ms16-oct
 
    <span style="color: blue"><code>cve_ids:</code></span> <span style="color: green">string</span>
    Specifies the list of Common Vulnerabilities and Exposures (CVE) IDs.
    Example: CVE-2016-3298, CVE-2016-3341, CVE-2016-3376
 
    <span style="color: blue"><code>date_posted:</code></span> <span style="color: green">string</span>
    Specifies the date of the patch release.
    Example: 2016-10-11 00:00:00.0
 
    <span style="color: blue"><code>vendor_impact:</code></span> <span style="color: green">string</span>
    Specifies the vendor-defined impact.
    Enum: [
      "Unknown",
      "Critical",
      "Important",
      "Low",
      "Moderate"
    ]
    Example: Critical
 
    <span style="color: blue"><code>q_numbers:</code></span> <span style="color: green">string</span>
    Specifies Knowledge Base (KB) number used to identify Microsoft patches associated with this bulletin.
    Example: [Q3185331, Q3185332
]

 
    <span style="color: blue"><code>bulletin_title:</code></span> <span style="color: green">string</span>
    Specifies the bulletin title.
    Example: {{This security update includes improvements and fixes from an update that was shipped earlier by update 3185278, 3185279 and 3185280.

This security update also resolves the following vulnerabilities in Windows:

•MS16-101 Security...[Truncated]}}
 
    superceded_by: string
    It specifies the name of the superseding bulletin.
    Example: CR16-004 CR16-003
 
    is_obsolete_bulletin: boolean
    Specifies whether the bulletin is marked obsolete.
    Example: True
 
    iava_id: string
    Specifies the ID of Information Assurance Vulnerability Alert (IAVA).
    Example: 2016-A-0278
}

Windows COM settings


 Information about options to register and unregister COM components. Applicable for Windows target servers.


{
    register: string
    The values are : both (default) or value interpreted by DeployOptions.REGISTER_COM_COMPONENTS* and DeployOptions.REGISTER_COM_COMPONENTS_FOR_UNDO* properties. Set this option to True to register COM objects during the Commit and Undo phase. If the Commit phase of a job run removes a file, the file is restored when that job run is undone. If a file is a COM object and this option was set to True during the Commit phase of the job run being undone, the file being restored is registered.
    Enum: [
      "at_commit",
      "at_undo",
      "both",
      "none"
    ]
 
    unregister: string
    The values are : both (default) or value interpreted by DeployOptions.UNREGISTER_COM_COMPONENTS_FOR_COMMIT* and DeployOptions.UNREGISTER_COM_COMPONENTS_FOR_UNDO* properties. Set this option to True to unregister COM objects during the Commit and Undo phase. If the Commit phase of a job run removes a file, the file is restored when that job run is undone. If a file is a COM object and this option was set to True during the Commit phase of the job run being undone, the file being restored is unregistered.
    Enum: [
      "at_commit",
      "at_undo",
      "both",
      "none"
    ]
}

Windows Group


 Information about Windows analysis group mode option.


{
    security_patches: boolean
    Default : true, (Recommended) Analyze patches that address security vulnerabilities. The patching job performs analysis against all patches in the patch catalog. Any security patch in the catalog that is found to be missing from the target being tested will show as missing in the job run log.
    Example: True
 
    security_tools: boolean
    Default : false, Analyze patches that prevent or clean up malicious software.
    Example: True
 
    non_security_patches: boolean
    Default : false, Analyze performance-related fixes, fixes for known bugs, and hardware drivers.
    Example: True
 
    exclude_service_packs: boolean
    Default : false, Do not include service packs in the analysis results.
    Example: True
}

Windows Patch Analysis Options


 Information about Windows patch analysis options.


{
    group: #Windows Group
    Classification of patches.
 
    list: #Include Exclude List for patches and patch groups
    List of patches.
}

Was this page helpful? Yes No Submitting... Thank you

Comments