Skip to content

job_execution_profile

Configuration for Job Execution Profile resource.

(click to see Operations)

Properties

(click to see Operations)

NameData TypePermissionsDescription
job_name<String>Read-writeJob Name.
variables<eventrule_config_variable[]>Read-writeValues of Variables used in commands of the configuration template.
template_info<eventrule_configuration_template>Read-writeConfiguration Template to be executed/scheduled.
id<String>Read-writeId is system generated key for all the job profile..
on_error<String>Read-writeBehaviour on encountering error while applying configuration template on a device: CONTINUE|EXIT|ROLLBACK.
Minimum length = 1
Maximum length = 16
instance_type<String>Read-writeInstance Type.
profile_name<String>Read-writeProfile name for the job setting..
Minimum length = 1
Maximum length = 128
tenant_id<String>Read-onlyTenant Id .

Operations

(click to see Properties)

ADD| DELETE| GET (ALL)| GET| UPDATE

Some options that you can use for each operations:

  • Getting warnings in response:NITRO allows you to get warnings in an operation by specifying the "warning" query parameter as "yes". For example, to get warnings while connecting to the NetScaler appliance, the URL is as follows:

    http://<netscaler-ip-address>/nitro/v1/config/login?warning=yes

    If any, the warnings are displayed in the response payload with the HTTP code "209 X-NITRO-WARNING".

  • Authenticated access for individual NITRO operations:NITRO allows you to logon to the NetScaler appliance to perform individual operations. You can use this option instead of creating a NITRO session (using the login object) and then using that session to perform all operations,

    To do this, you must specify the username and password in the request header of the NITRO request as follows:

    X-NITRO-USER:<username>

    X-NITRO-PASS:<password>

    Note: In such cases, make sure that the request header DOES not include the following:

    Cookie:NITRO_AUTH_TOKEN=<tokenvalue>

Note:

Mandatory parameters are marked in red and placeholder content is marked in <green>.

add

URL: https://<MGMT-IP>/nitro/v1/config/job_execution_profile?onerror=<String_value>

HTTP Method: null

Request Payload:

{job_execution_profile: {
<b>"profile_name":<String_value></b>,
"id":<String_value>,
"template_info":<eventrule_configuration_template_value>,
"on_error":<String_value>,
"variables":[{
<b>"name":<String_value></b>,
"parent_id":<String_value>,
"default_value":<String_value>,
"id":<String_value>,
"values_enum_db":<String_value>,
"parent_name":<String_value>,
"value":<String_value>,
"description":<String_value>,
"type":<String_value>,
"device_values":[{
"parent_name":<String_value>,
"value":<String_value>,
"device":<String_value>,
"device_group":<String_value>,
"parent_id":<String_value>,
"id":<String_value>}],
"display_name":<String_value>}],
"job_name":<String_value>,
"instance_type":<String_value>}}

Response Payload:

{ "errorcode": 0, "message": "Done", "severity": ;ltString_value>, "job_execution_profile":[{
"tenant_id":<String_value>,
"job_name":<String_value>,
"variables":[{
"device_values_mapping":<String_value>,
"parent_name":<String_value>,
"value":<String_value>,
"name":<String_value>,
"display_name":<String_value>,
"description":<String_value>,
"device_values":[{
"parent_name":<String_value>,
"value":<String_value>,
"id":<String_value>,
"device_group":<String_value>,
"device":<String_value>,
"parent_id":<String_value>}],
"parent_id":<String_value>,
"default_value":<String_value>,
"id":<String_value>,
"type":<String_value>,
"values_enum_db":<String_value>}],
"template_info":<eventrule_configuration_template_value>,
"id":<String_value>,
"on_error":<String_value>,
"instance_type":<String_value>,
"profile_name":<String_value>}]}

delete

URL: https://<MGMT-IP>/nitro/v1/config/job_execution_profile/id_value<String>

HTTP Method: null

Response Payload:

{ "errorcode": 0, "message": "Done", "severity": ;ltString_value> }

get (all)

URL: https://<MGMT-IP>/nitro/v1/config/job_execution_profile

HTTP Method: null

Response Payload:

{ "errorcode": 0, "message": "Done", "severity": ;ltString_value>, "job_execution_profile":[{
"tenant_id":<String_value>,
"job_name":<String_value>,
"variables":[{
"device_values_mapping":<String_value>,
"parent_name":<String_value>,
"value":<String_value>,
"name":<String_value>,
"display_name":<String_value>,
"description":<String_value>,
"device_values":[{
"parent_name":<String_value>,
"value":<String_value>,
"id":<String_value>,
"device_group":<String_value>,
"device":<String_value>,
"parent_id":<String_value>}],
"parent_id":<String_value>,
"default_value":<String_value>,
"id":<String_value>,
"type":<String_value>,
"values_enum_db":<String_value>}],
"template_info":<eventrule_configuration_template_value>,
"id":<String_value>,
"on_error":<String_value>,
"instance_type":<String_value>,
"profile_name":<String_value>}]}

get

URL: https://<MGMT-IP>/nitro/v1/config/job_execution_profile/id_value<String>

HTTP Method: null

Response Payload:

{ "errorcode": 0, "message": "Done", "severity": ;ltString_value>, "job_execution_profile":[{
"tenant_id":<String_value>,
"job_name":<String_value>,
"variables":[{
"device_values_mapping":<String_value>,
"parent_name":<String_value>,
"value":<String_value>,
"name":<String_value>,
"display_name":<String_value>,
"description":<String_value>,
"device_values":[{
"parent_name":<String_value>,
"value":<String_value>,
"id":<String_value>,
"device_group":<String_value>,
"device":<String_value>,
"parent_id":<String_value>}],
"parent_id":<String_value>,
"default_value":<String_value>,
"id":<String_value>,
"type":<String_value>,
"values_enum_db":<String_value>}],
"template_info":<eventrule_configuration_template_value>,
"id":<String_value>,
"on_error":<String_value>,
"instance_type":<String_value>,
"profile_name":<String_value>}]}

update

URL: https://<MGMT-IP>/nitro/v1/config/job_execution_profile/id_value<String>

HTTP Method: null

Request Payload:

{job_execution_profile:{
<b>"id":<String_value></b>,
"template_info":<eventrule_configuration_template_value>,
"on_error":<String_value>,
"variables":[{
<b>"name":<String_value></b>,
"parent_id":<String_value>,
"default_value":<String_value>,
"id":<String_value>,
"values_enum_db":<String_value>,
"parent_name":<String_value>,
"value":<String_value>,
"description":<String_value>,
"type":<String_value>,
"device_values":[{
"parent_name":<String_value>,
"value":<String_value>,
"device":<String_value>,
"device_group":<String_value>,
"parent_id":<String_value>,
"id":<String_value>}],
"display_name":<String_value>}],
"job_name":<String_value>,
"instance_type":<String_value>,
"profile_name":<String_value>}}

Response Payload:

{ "errorcode": 0, "message": "Done", "severity": ;ltString_value>, "job_execution_profile":[{
"tenant_id":<String_value>,
"job_name":<String_value>,
"variables":[{
"device_values_mapping":<String_value>,
"parent_name":<String_value>,
"value":<String_value>,
"name":<String_value>,
"display_name":<String_value>,
"description":<String_value>,
"device_values":[{
"parent_name":<String_value>,
"value":<String_value>,
"id":<String_value>,
"device_group":<String_value>,
"device":<String_value>,
"parent_id":<String_value>}],
"parent_id":<String_value>,
"default_value":<String_value>,
"id":<String_value>,
"type":<String_value>,
"values_enum_db":<String_value>}],
"template_info":<eventrule_configuration_template_value>,
"id":<String_value>,
"on_error":<String_value>,
"instance_type":<String_value>,
"profile_name":<String_value>}]}