Download full document:

configJob

Configuration Job

show | add

show configJob

Use this operation to get config job

Synopsys

show configJob [id=<string>]

Parameters

id

Id is system generated key for all the configuration jobs

add configJob

Use this operation to run config job

Synopsys {#synopsys-1 style="margin-left: 20px;"}

add configJob [execute_username=<string>] [nextScheduleTimeEpoch=<string>] [template_info=<configuration_template>] [node_id=<string>] [timestamp=<int>] [scheduleType=<string>] [on_error=<string>] [lastExecutedTimeEpoch=<string>] [name=<string>] [scheduleTimes=<string>] [device_groups=<string...>] [sms_profiles=<string>] [device_family=<string>] [tz_offset=<int>] [status=<string>] [execute_password=<stringx>] [variables=<variable_values...>] [devices_db=<string>] [execute_sequentially=(false | true)] [scheduleOptions=<string>] [scheduleTimesEpoch=<string>] [device_groups_db=<string>] [mail_profiles=<string>] [lastExecutionStatus=<string>] [devices=<ipaddress...>] [credentials_required=(false | true)] [preview_rollback_commands=<string...>] [devices_completed_count=<int>] [devices_count=<int>] [preview_commands=<string...>]

Parameters {#parameters-1 style="margin-left: 20px;"}

execute_username

Execute User Name for job

nextScheduleTimeEpoch

Schedule time epoch at which job is scheduled to be run next.

template_info

Configuration Template to be executed/scheduled

node_id

Node id of the node executing the task in a Multinode / HA deployment

timestamp

Time of Creation of Configuration Job

scheduleType

Schedule Type of Configuration Template that is scheduled

on_error

Behaviour on encountering error while applying configuration template on a device: CONTINUE|EXIT|ROLLBACK

lastExecutedTimeEpoch

Schedule time epoch at which job was last executed.

name

Name of configuration job

scheduleTimes

Comma Seperated times of the day(HH:MM) on which Configuration Template is scheduled

device_groups

Device Group Array on which for which job is run

sms_profiles

Comma seperated list of SMS profiles

device_family

Family of Devices for which config job was executed

tz_offset

Time zone offset.

status

Status of Config Job

execute_password

Execute Password for job

variables

Values of Variables used in commands of the configuration template

devices_db

Device IP Address List Comma Seperated on which job is run

execute_sequentially

True if configuration template is to be applied to devices sequentially

scheduleOptions

Comma Seperated Options for scheduling Configuration Template

scheduleTimesEpoch

Schedule time epoch (string representation of 11 digit numbers).

device_groups_db

Device Groups List Comma Seperated on which job is run

mail_profiles

Comma seperated list of Mail profiles

lastExecutionStatus

Status of last Execution of Config Job

devices

Device IP Address Array on which job is run

credentials_required

True if username/password need to be asked before configuration template is to applied on devices

preview_rollback_commands

Preview of list of rollback commands

devices_completed_count

Devices Completed Count

devices_count

Number of Devices on which commands executed

preview_commands

Preview of list of commands