activate_device

Mark a device as activated.

Description

• ip - a.b.c.d where 0 <= a,b,c,d <= 255. You may optionally prefix the IP with SITE: where SITE is the name of the Site the device is in.
• host - A valid hostname
• fqdn - A valid Fully Qualified Domain Name
• deviceid - A device ID

SOAP API Format

add_advanced_script

Add a new advanced script.

Description

• name - Name for the new advanced script
• description - Description for the new advanced script
• scripttype - Script type (i.e. user defined subcategory)
• family - Device family for the new advanced script
• language - Language for the new advanced script - must be a supported language such as Expect or Perl
• parameters - Command line parameters for the new advanced script
• script - Script text
• sitename - Site name

SOAP API Format

add_authentication

Add device password information.

Description

This command can modify passwords on a specific device or device group, or merely update what the system knows of a device's or network's password information. The -ip option provides information specific to the device. Otherwise, the command adds a network-wide password rule to the system. When using this command to modify passwords on a device, the modification operation is actually a scheduled task.

• loc - The location to which password information should be written. Valid values for this argument are "db", "device", and "group". "db" tells the command that password information should be changed only in the system's database. "device" tells the command that the password changes should be made on the device as well and "group" performs the same function as "device" but across all devices in the group.
• ip - a.b.c.d where 0 <= a,b,c,d <= 255. You may optionally prefix the IP with SITE: where SITE is the name of the Site the device is in.: The device to which this password information should apply.
• host - A valid hostname: An existing device to which this password information should apply.
• fqdn - A valid Fully Qualified Domain Name: An existing device to which this password information should apply.
• deviceid - A device ID
• snmpro - When used in conjunction with -loc db, this argument is taken as a single community string understood by the system as THE read only community string for the device or network. When used in conjunction with -loc device, this argument is taken as a comma-seperated list of read only community strings to be, either set on the device, or appended to an existing list of read only community strings (depends on whether or not the -appendsnmpro flag was supplied.)
• snmprw - When used in conjunction with -loc db, this argument is taken as a single community string understood by the system as THE read write community string for the device or network. When used in conjunction with -loc device, this argument is taken as a comma-seperated list of read write community strings to be, either set on the device, or appended to an existing list of read write community strings (depends on whether or not the -appendsnmprw flag was supplied.)
• snmpv3user - When used in conjunction with -loc db, this argument is taken as the username for snmpv3 access.
• snmpv3authpw - When used in conjunction with -loc db, this argument is taken as the authentication password for snmpv3 access.
• snmpv3encryptpw - When used in conjunction with -loc db, this argument is taken as the encryption password for snmpv3 access.
• user - Username.
• passwd - Password.
• enableuser - ADDITIONAL username to get to "enable" mode.
• enablepasswd - ADDITIONAL password to get to "enable" mode.
• connectionmethods - The methods used by the system to connect to devices. Can be telnet, serial_direct, or SSH.
• accessvariables - To override variables in the script, such as prompts.
• start - YYYY:MM:DD:HH:mm. The first date on which the task will run. Use this option only if the argument to the -loc flag is "device".
• appendsnmpro - Supply this option if read only community strings should be appended to any existing on the device. Use this option only if the argument to the -loc flag is "device".
• appendsnmprw - Supply this option if read write community strings should be appended to any existing on the device. Use this option only if the argument to the -loc flag is "device".
• sync - Indicates that the command should return only after the password change task is complete. Do not use this option with -start.
• group - The group name for performing this command across all devices in a group.
• site - The site partition this rule will be applied to. Default to be global
• rule - the rule name to be added
• rulehostname - Hostname, the rule applies to
• ruledevicegroup - Device group name, the rule applies to
• iprangestart - IP start range, the rule applies to
• iprangeend - IP end range, the rule applies to

SOAP API Format

add_command_script

Add a new command script.

Description

• name - Name for the new command script
• description - Description for the new command script
• scripttype - Script type (i.e. user defined subcategory)
• mode - Command script mode
• driver - List of applicable drivers - provided as a comma separated list of internal driver names
• script - Script text
• sitename - Site name

SOAP API Format

add_device

Add a device to the system.

Description

• ip - a.b.c.d where 0 <= a,b,c,d <= 255. You may optionally prefix the IP with SITE: where SITE is the name of the Site the device will be put in.
• hostname - The device's host name
• comment - Additional information regarding the device.
• description - The descriptive name of the device (informational only).
• model - The device's model (such as 2620).
• vendor - The device's vendor (such as Cisco).
• domain - A fully qualified domain name (such as www.google.com).
• serial - The device's serial number.
• asset - The device's asset tag.
• location - The device's location.
• unmanaged - 0: Mark this device as managed by the system. 1: Mark this device to be unmanaged by the system.
• nopoll - 0: Mark this device to be polled for changes. 1: Mark this device as not to be polled for changes.
• consoleip - a.b.c.d where 0 <= a,b,c,d <= 255
• consoleport - The port number
• tftpserverip - a.b.c.d where 0 <= a,b,c,d <= 255
• natip - a.b.c.d where 0 <= a,b,c,d <= 255
• useconsoleserver - true, if the device uses a console server. false, if the device does not. If this option is not provided, it is assumed that the device does not use a console server.
• accessmethods - A comma-separated list of access methods, or "none". The set of access methods: {telnet, ssh, rlogin, SCP, FTP, TFTP, SNMP, snmp_noauthnopriv, snmp_authnopriv, snmp_authpriv}. If this option is not provided, the system will try all access methods when attempting to connect to the device.
• hierarchylayer - This device attribute is used in diagramming. When you config a network diagram, you can select which hierarchy layers on which to filter. Valid values include: (core, distribution, access, edge and "layer not set").

SOAP API Format

add_device_to_group

Add a device to a device group.

Description

• ip - a.b.c.d where 0 <= a,b,c,d <= 255. You may optionally prefix the IP with SITE: where SITE is the name of the Site the device is in.
• host - A valid hostname
• fqdn - A valid Fully Qualified Domain Name
• deviceid - A device ID
• group - The name of the device group to which the device should be added.

SOAP API Format

add_diagnostic

Add a new custom diagnostic script.

Description

• name - Name for the new diagnostic
• description - Description for the new diagnostic
• mode - Command script mode
• driver - List of applicable drivers - provided as a comma separated list of internal driver names
• script - Diagnostic script text
• sitename - Site name

SOAP API Format

add_event

Add an event.

Description

An email message (containing the event) will be the result of an added events if the system is configured to send email for added events.

• message - The text of the event
• ip - a.b.c.d where 0 <= a,b,c,d <= 255. You may optionally prefix the IP with SITE: where SITE is the name of the Site the device is in.
• host - A valid hostname
• fqdn - A valid Fully Qualified Domain Name

SOAP API Format

add_event_rule

Add a event rule.

Description

Add new event rule. It will subscribe provided host to the system events.

• name - The name identifier for event rule
• action - event type, for now only support snmp and integration, use -action snmp/integration
• receiverhost - A valid hostname or ip address
• receiverport - A numeric port, if not provided, then 162 will be used
• events - List of event types, separated by column. If not provided, then ALL will be used
• community - Community string, if not provided, then public will be used
• eventtemplate - Specify the absolute path to the file which contains the event text template. The file must be directly accessible by the system.
• eventtext - Specify the event text
• site - Name of teh site the rule will be added to. The rule will be global if site name is null or not specified

SOAP API Format

add_group

Add a group to the system.

Description

• name - The name of the group to add.
• type - The type of the group to add. "device" and "user" are the valid values for this option.
• comment - Additional information about the group.
• shared - 1 if the group is shared, 0 if it is not.

SOAP API Format

add_group_to_parent_group

Add a device group to a parent device group.

Description

• parent - Name of the parent group
• child - Name of the child group

SOAP API Format

add_image

Add images to database.

Description

Add images to database. Must specify either driver or model

• site - The site the image will be applicable to. The image will be global if site is not specified.
• imageset - The imageset the images will add to.
• images - The images to add. The paths specified by this option must point to files accessible by the management server. Files must be placed on the management server first.
• driver - The driver the images required.
• model - The device model the images required.
• memory - The minimum system memory required (in bytes) for images.
• processor - The hardware required for images.
• bootrom - The BootROM required for images.

SOAP API Format

add_imageoption

Add information for device which is not under management but needed for software image update.

Description

Add information for device which is not under management but needed for software image update.

• imagemodels - device model to be added.
• imageprocessors - device processors to be added.
• imagebootroms - device BootROMs to be added.

SOAP API Format

add_ip

Add new secondary ip.

Description

• ipvalue - The ip value a.b.c.d where 0 <= a,b,c,d <= 255
• deviceip - The device's ip address a.b.c.d where 0 <= a,b,c,d <= 255. You may optionally prefix the IP with SITE: where SITE is the name of the Site the device is in.
• comment - Additional information regarding the device.
• usetoaccess - Use this IP Value to access its device, 0 - yes, 1 - no, default - no
• ip - a.b.c.d where 0 <= a,b,c,d <= 255. You may optionally prefix the IP with SITE: where SITE is the name of the Site the device is in.
• host - A valid hostname
• fqdn - A valid Fully Qualified Domain Name
• deviceid - A device ID

SOAP API Format

add_metadata

Add a piece of custom data to be associated with a specific field and associated entity.

Description

• fieldid - Field ID the data is to be associated with
• data - Data to be associated, if not included, data is null
• associatedtableid - ID of the associated row the data coresponds to

SOAP API Format

add_metadata_field

Used to define a custom data field for a specific table.

Description

• fieldname - Name of the field to be added
• fieldvalues - List of comma separated values that the field is restricted to. If not specified, the value for this field is not restricted
• inuse - Turns the field on or off. 1 is on, 0 is off. When the field is off, it will not be displayed with the other custom fields.
• flags - Used for allowing HTML in the field value. 1 is allow, 0 is disallow. If disallowed, HTML will be escaped for displaying.
• associatedtable - The table to associate this field with

SOAP API Format

add_parent_group

Add a parent group to the system.

Description

• name - The name of the parent group to add.
• type - The type of the parent group to add. "device" is currently the only valid argument to this option.
• comment - Additional information about the parent group.

SOAP API Format

add_partition

Add a partition to view.

Description

• viewname - The name of the view this partition goes to.
• name - The name of the partition to add.
• comment - Additional information about the partition.

SOAP API Format

add_snmp_trap_config

Description

SOAP API Format

add_system_message

Add a system message.

Description

An email message (containing the system message) will be the result of an added system messages if the system is configured to send email for added events.

• message - The text of the system message
• ip - a.b.c.d where 0 <= a,b,c,d <= 255. You may optionally prefix the IP with SITE: where SITE is the name of the Site the device is in.
• host - A valid hostname
• fqdn - A valid Fully Qualified Domain Name
• deviceid - A device ID

SOAP API Format

add_user

Add a user to the system.

Description

• u - Username
• p - Password
• fn - First name
• ln - Last name
• email - Email address
• aaausername - AAA username for this user.
• aaapassword - AAA password for this user.
• useaaaloginforproxy - Whether to user AAA logins for the Proxy Interface for this user (yes|no).
• extauthfailover - Whether to allow external auth failover for this user (yes|no).

SOAP API Format

add_user_to_group

Add a user to a user group.

Description

• u - Username
• g - User group name

SOAP API Format

annotate_access

Modify the comments on, or the display name of, a device access record.

Description

• id - Specifies a device access record. Think of this as a "device access record ID".
• comment - Additional information regarding the access record.
• name - An optional name for the access record.
• customname - The custom field name
• customvalue - The custom field value

SOAP API Format

annotate_config

Add a comment to the specified config.

Description

Note that comments added by means of this command are not added to the config itself. They are stored seperately along with the config.

• id - The ID of the config on which you are commenting.
• comment - Additional information regarding the config.

SOAP API Format

assign_driver

Manually assign driver to device.

Description

• ip - a.b.c.d where 0 <= a,b,c,d <= 255. You may optionally prefix the IP with SITE: where SITE is the name of the Site the device is in.
• id - A valid device id
• name - A valid internal driver name, supported by system

SOAP API Format

configure_syslog

Configure a device to send syslog messages to the system's change detection facilites.

Description

Have the system configure the specified device to send all syslog messages necessary for the system's change detection facilites to function optimally to the system's syslog server. The configuration operation is atually a scheduled task.

• ip - a.b.c.d where 0 <= a,b,c,d <= 255. You may optionally prefix the IP with SITE: where SITE is the name of the Site the device is in.
• group - A valid group name. Do not use this option with -ip (exactly one of -ip or -group must be specified).
• host - A valid hostname
• fqdn - A valid Fully Qualified Domain Name
• deviceid - A device ID
• rep - (#min | #:# | #days | #weeks | #months) where # is a positive integer. #:# is hours:minutes--the two integers do not have to be the same. Do not use this option with -sync.
• sync - Indicates the command should return only after the Configure Syslog task is complete. Do not use this option with -rep or -start.
• start - YYYY:MM:DD:HH:mm. The first date on which the task will run.
• comment - An optional comment about the Configure Syslog task.
• usesyslogrelay - Indicates to the syslog configuration task that the device currently logs to syslog relay host. Supply this option if you wish to set up forwarding on that relay host rather than have the device log directly to the system's syslog server. The specified IP address is taken to be the IP address of the relay host.

SOAP API Format

deactivate_device

Mark a device as deactivated.

Description

• ip - a.b.c.d where 0 <= a,b,c,d <= 255. You may optionally prefix the IP with SITE: where SITE is the name of the Site the device is in.
• host - A valid hostname
• fqdn - A valid Fully Qualified Domain Name
• deviceid - A device ID

SOAP API Format

del_access

Delete access records.

Description

This command can delete a single access record when provided that record's id (via. the option "-id"), or all access records prior to a given date (via the option "-cutoff"). Provide exactly one of "-id", "-cutoff". Note that deleting access records will cause all configs associated with the deleted access record to also be deleted.

• id - A device access record ID.
• cutoff - YYYY:MM:DD:HH:mm. All access records prior to this date will be deleted.

SOAP API Format

del_authentication

Deletes all password information associated with the specified device. Or delete authentication rule from database.

Description

• ip - a.b.c.d where 0 <= a,b,c,d <= 255. You may optionally prefix the IP with SITE: where SITE is the name of the Site the device is in.: The device for which password information should be deleted.
• host - A valid hostname: The device for which password information should be deleted.
• fqdn - A valid Fully Qualified Domain Name: The device for which password information should be deleted.
• deviceid - A device ID
• loc - Location
• site - site of rules to be deleted
• rulename - anme fo rules to be deleted

SOAP API Format

del_device

Delete the specified device.

Description

• ip - a.b.c.d where 0 <= a,b,c,d <= 255. You may optionally prefix the IP with SITE: where SITE is the name of the Site the device is in.
• host - A valid hostname
• fqdn - A valid Fully Qualified Domain Name
• deviceid - A device ID

SOAP API Format

del_device_data

Delete device configuration and diagnostic data.

Description

This command can delete a single device data block when provided that device data id (via. the option "-id"), or all device data prior to a given date (via the option "-cutoff"). Provide exactly one of "-id", "-cutoff".

• id - A config ID
• cutoff - YYYY:MM:DD:HH:mm. All configs prior to this date will be deleted.

SOAP API Format

del_device_from_group

Delete a device from a device group.

Description

• ip - a.b.c.d where 0 <= a,b,c,d <= 255. You may optionally prefix the IP with SITE: where SITE is the name of the Site the device is in.
• host - A valid hostname
• fqdn - A valid Fully Qualified Domain Name
• deviceid - A device ID
• group - The name of the device group from which the device should be deleted.

SOAP API Format

del_drivers

Delete all drivers associated with a device.

Description

• ip - a.b.c.d where 0 <= a,b,c,d <= 255. You may optionally prefix the IP with SITE: where SITE is the name of the Site the device is in.
• host - A valid hostname
• fqdn - A valid Fully Qualified Domain Name
• deviceid - A device ID

SOAP API Format

del_event

Delete the specified event.

Description

• id - A valid event id

SOAP API Format

del_group

Delete a group from the system.

Description

Specify the group by both its name and type.

• name - The name of the group to be removed.
• type - The type of the group to be removed.

SOAP API Format

del_group_from_parent_group

Remove a device group from a parent device group.

Description

• parent - Name of the parent group
• child - Name of the child group

SOAP API Format

del_ip

Delete the specified ip.

Description

• ipvalue - The ip value a.b.c.d where 0 <= a,b,c,d <= 255
• deviceip - The device's ip address a.b.c.d where 0 <= a,b,c,d <= 255. You may optionally prefix the IP with SITE: where SITE is the name of the Site the device is in.
• ip - a.b.c.d where 0 <= a,b,c,d <= 255. You may optionally prefix the IP with SITE: where SITE is the name of the Site the device is in.
• host - A valid hostname
• fqdn - A valid Fully Qualified Domain Name
• deviceid - A device ID

SOAP API Format

del_metadata

Delete a specific piece of custom data.

Description

• metadataid - ID of the custom data to delete

SOAP API Format

del_metadata_field

Delete a custom data field and all data currently associated with that field.

Description

• fieldid - ID of the custom data field to delete

SOAP API Format

del_partition

Delete a partition from view.

Description

• name - The name of the partition to be removed.

SOAP API Format

del_script

Delete an existing command script, advanced script or diagnostic.

Description

Delete the indicated command script, advanced script or diagnostic. The desired script or diagnostic can be specified by ID, or by a combination of name and type. If more than one name match occurs, then an error will be reported and you must specify the unique script desired by ID.

• id - ID of the desired script or diagnostic
• name - Name of the desired script or diagnostic
• type - Type of the desired script or diagnostic - may be command, advanced or diagnostic

SOAP API Format

del_session

Delete an interceptor log record.

Description

• id - Interceptor log ID

SOAP API Format

del_system_message

Delete the specified system message.

Description

• id - A valid system message id

SOAP API Format

del_task

Delete a task.

Description

Deletes a task, whether it has run or not.

• id - A task ID

SOAP API Format

del_user

Delete a user from the system.

Description

• u - The user name to be deleted

SOAP API Format

del_user_from_group

Delete a user from a user group.

Description

• u - Username
• g - User group name

SOAP API Format

delete_image

Delete software images from database

Description

Delete software images from database

• site - the site which the image belongs to. Will assume to be global if not specified.
• imageset - imageset name the images will be deleted.
• images - images to be deleted.

SOAP API Format

deploy_config

Deploy config to a device.

Description

Deploy the specified config to a specified device either right away, or at some point in the future. The deploy operation is actually a scheduled task.

• ip - a.b.c.d where 0 <= a,b,c,d <= 255. You may optionally prefix the IP with SITE: where SITE is the name of the Site the device is in.
• host - A valid hostname
• fqdn - A valid Fully Qualified Domain Name
• deviceid - A device ID
• id - The ID of the config to deploy to the specified device.
• configtext - The configuration text to deploy to the specified device.
• start - YYYY:MM:DD:HH:mm. The first date on which the task will run. Do not use this option with -sync.
• sync - Indicates that the command should return only after the deploy task is complete. Do not use this option with -start.
• option - current or startup_reload, as applicable to the device.

SOAP API Format

deploy_image

Deploy software images to device.

Description

Deploy software images to device.

• ip - ip address of the device the images will deploy to.
• site - partition site which the imageset belongs to. Will look for global imagesets if not specified.
• imageset - imageset name the images from.
• images - images from the imageset to be deployed.
• reboot - wheather to reboot the device after deploy images.
• rebootwait - seconds to wait before reboot.
• filesystem - filesystem name of the device the images will deploy to.
• pretask - name of task before deployment.
• posttask - name of task after deployment.
• verify - verify the image after deployment.
• start - YYYY:MM:DD:HH:mm. The first date on which the task will run. The string "now" means the current time. The string "tomorrow" means 24 hours from the current time.
• comment - An optional comment about the snapshot.
• duration - A number concatenated with a units signifier. Valid signifiers are m (minutes), h (hours), d (days), w (weeks). If this option is not provided, the duration for the task is set to 60 minutes.
• sessionlog - If true a complete session log will be saved with this task.
• customname - The custom field name.
• customvalue - The custom field value.
• retryInterval - The number of seconds between retries.
• retryCount - The number of times to retry the task if it fails.

SOAP API Format

diff_config

Show the differences between two configs.

Description

• id1 - The ID of a config
• id2 - The ID of a config

SOAP API Format

disable_device

Mark a device as disabled.

Description

• ip - a.b.c.d where 0 <= a,b,c,d <= 255. You may optionally prefix the IP with SITE: where SITE is the name of the Site the device is in.
• host - A valid hostname
• fqdn - A valid Fully Qualified Domain Name
• deviceid - A device ID

SOAP API Format

discover_driver

Discover a driver for a device.

Description

Attempts to match a driver to the specified device.

• ip - a.b.c.d where 0 <= a,b,c,d <= 255. You may optionally prefix the IP with SITE: where SITE is the name of the Site the device is in.: The device for which a driver should be discovered.
• host - A valid hostname: The device for which a driver should be discovered.
• fqdn - A valid Fully Qualified Domain Name: The device for which a driver should be discovered.
• deviceid - A device ID

SOAP API Format

discover_drivers

Discover drivers for all devices.

Description

Attempts to match a driver to each device that the system recognizes.

• noskip - do not skip devices with known drivers
• group - discover drivers for specified group

SOAP API Format

enable_device

Mark a device as enabled.

Description

• ip - a.b.c.d where 0 <= a,b,c,d <= 255. You may optionally prefix the IP with SITE: where SITE is the name of the Site the device is in.
• host - A valid hostname
• fqdn - A valid Fully Qualified Domain Name
• deviceid - A device ID

SOAP API Format

generate_stacktrace

Description

SOAP API Format

get_snapshot

Get the config from a device.

Description

Get the config from a specified device either right away, or at some point in the future. The retrieval operation is actually a scheduled task. Using this command, you can set the task to repeat periodically.

• ip - a.b.c.d where 0 <= a,b,c,d <= 255. You may optionally prefix the IP with SITE: where SITE is the name of the Site the device is in.
• group - A valid group name. Do not use this option with -ip (exactly one of -ip or -group must be specified).
• host - A valid hostname
• fqdn - A valid Fully Qualified Domain Name
• deviceid - A device ID
• rep - (#min | #:# | #days | #weeks | #months) where # is a positive integer. #:# is hours:minutes--the two integers do not have to be the same. Do not use this option with -sync.
• sync - Indicates the command should return only after the snapshot retrieval task is complete. Do not use this option with -rep or -start.
• start - YYYY:MM:DD:HH:mm. The first date on which the task will run. The string "now" means the current time. The string "tomorrow" means 24 hours from the current time.
• comment - An optional comment about the snapshot.
• duration - A number concatenated with a units signifier. Valid signifiers are m (minutes), h (hours), d (days), w (weeks). If this option is not provided, the duration for the task is set to 60 minutes.
• sessionlog - If true a complete session log will be saved with this task.
• customname - The custom field name.
• customvalue - The custom field value.
• retryInterval - The number of seconds between retries.
• retryCount - The number of times to retry the task if it fails.

SOAP API Format

import

Import device or device password information.

Description

This command can import into the system device or device password information contained in appropriately formatted CSV files. (Contact customer support for a CSV file format specification.)

• input - Either the name of a file that contains CSV data or the CSV data itself.
• data - Whether the type of information imported is devices or device authentication.
• log - Command log file.
• append - If true, this command will append to the log file. If false, this command will overwrite the log file. This option is false by default.
• discoverafter - Discover drivers for imported device? This option is false by default.
• configuresyslog - Configure devices to send syslog messages to the system? Valid values are true | false
• usesyslogrelay - The name of a syslog relay host to use
• filter - An application that reads the input file from stdin, and writes a the system compatible CSV file to stdout.
• cleanafter - If true, then after importing data, a process will run on the server that will delete old devices. Devices are deleted according to the current configuration of the system's "deletion-on-import" rules, and the argument to the deviceorigin option. This option is false by default.
• deviceorigin - A description of the source of the data. This is recorded by the system, but is not visible via any UI.
• debug - Include debug information in log file.

SOAP API Format

list_access

List all access records for a device.

Description

• ip - a.b.c.d where 0 <= a,b,c,d <= 255. You may optionally prefix the IP with SITE: where SITE is the name of the Site the device is in.
• host - A valid hostname
• fqdn - A valid Fully Qualified Domain Name
• deviceid - A device ID
• start - Display only those access records created on or after the given date. Values for this option may be in one of the following formats: YYYY-MM-DD HH:MM:SS e.g. 2002-09-06 12:30:00 YYYY-MM-DD HH:MM e.g. 2002-09-06 12:30 YYYY-MM-DD e.g. 2002-09-06 YYYY/MM/DD e.g. 2002/09/06 YYYY:MM:DD:HH:MM e.g. 2002:09:06:12:30 Or, one of: now, today, yesterday, tomorrow Or, in the format: " " e.g. "3 days ago" is a positive integer. is one of: seconds, minutes, hours, days, weeks, months, years;. is one of: ago, before, later, after.
• end - Display only those access records created on or before the given date. Values for this option have the same format as for the option -start.

SOAP API Format

list_access_all

List all access records for all devices.

Description

SOAP API Format

list_acl

List ACLs.

Description

Lists all device ACLs in the system unless you include any of the options to limit the ACLs listed.

• host - A valid host name.
• ip - List only ACLs with a valid IP Address (of format a.b.c.d where 0 <= a,b,c,d <= 255.)
• fqdn - List only ACLs with a valid Fully Qualified Domain Name
• deviceid - List only ACLs with this deviceid.
• aclid - List only ACLs with this aclid.
• handle - List only ACLs with this handle
• recent - Display only those acl's that are most recent.
• includescript - Include Script in the display.
• includeapplication - Include Application in the display.

SOAP API Format

list_agvalues

Description

SOAP API Format

list_all_drivers

List all drivers installed in the system.

Description

SOAP API Format

list_authentication

list Authentication.

Description

Displays the Authentication Rules by Rule Name.

• rulename - List Authentication by rule name

SOAP API Format

list_basicip

List all configs for which the BasicIP model can be shown.

Description

• ip - a.b.c.d where 0 <= a,b,c,d <= 255. You may optionally prefix the IP with SITE: where SITE is the name of the Site the device is in.
• host - A valid hostname
• fqdn - A valid Fully Qualified Domain Name
• deviceid - A device ID
• start - Display only those configs stored on or after the given date. Values for this option may be in one of the following formats: YYYY-MM-DD HH:MM:SS e.g. 2002-09-06 12:30:00 YYYY-MM-DD HH:MM e.g. 2002-09-06 12:30 YYYY-MM-DD e.g. 2002-09-06 YYYY/MM/DD e.g. 2002/09/06 YYYY:MM:DD:HH:MM e.g. 2002:09:06:12:30 Or, one of: now, today, yesterday, tomorrow Or, in the format: e.g. 3 days ago is a positive integer. is one of: seconds, minutes, hours, days, weeks, months, years;. is one of: ago, before, later, after.
• end - Display only those configs stored on or before the given date. Values for this option have the same format as for the option -start.

SOAP API Format

list_config

List all configs for the specified device.

Description

• ip - a.b.c.d where 0 <= a,b,c,d <= 255. You may optionally prefix the IP with SITE: where SITE is the name of the Site the device is in.
• host - A valid hostname
• fqdn - A valid Fully Qualified Domain Name
• deviceid - A device ID
• start - Display only those configs stored on or after the given date. Values for this option may be in one of the following formats: YYYY-MM-DD HH:MM:SS e.g. 2002-09-06 12:30:00 YYYY-MM-DD HH:MM e.g. 2002-09-06 12:30 YYYY-MM-DD e.g. 2002-09-06 YYYY/MM/DD e.g. 2002/09/06 YYYY:MM:DD:HH:MM e.g. 2002:09:06:12:30 Or, one of: now, today, yesterday, tomorrow Or, in the format: e.g. 3 days ago is a positive integer. is one of: seconds, minutes, hours, days, weeks, months, years;. is one of: ago, before, later, after.
• end - Display only those configs stored on or before the given date. Values for this option have the same format as for the option -start.
• size - Display the size (in bytes) of each config
• ids - List only configs in this comma-separated list of IDs.

SOAP API Format

list_config_all

List all configs for all devices.

Description

SOAP API Format

list_config_id

List config IDs for the specified configs.

Description

• ip - a.b.c.d where 0 <= a,b,c,d <= 255. You may optionally prefix the IP with SITE: where SITE is the name of the Site the device is in.
• host - A valid hostname
• fqdn - A valid Fully Qualified Domain Name
• deviceid - A device ID
• start - Display only those configs stored on or after the given date. Values for this option may be in one of the following formats: YYYY-MM-DD HH:MM:SS e.g. 2002-09-06 12:30:00 YYYY-MM-DD HH:MM e.g. 2002-09-06 12:30 YYYY-MM-DD e.g. 2002-09-06 YYYY/MM/DD e.g. 2002/09/06 YYYY:MM:DD:HH:MM e.g. 2002:09:06:12:30 Or, one of: now, today, yesterday, tomorrow Or, in the format: e.g. 3 days ago is a positive integer. is one of: seconds, minutes, hours, days, weeks, months, years;. is one of: ago, before, later, after.
• end - Display only those configs stored on or before the given date. Values for this option have the same format as for the option -start.
• id - Display only the specified config id.

SOAP API Format

list_custom_data_definition

list Custom Data Definition.

Description

List Custom Data Definition by table name.

• tablename - List Custom Data for specific table

SOAP API Format

list_device

List devices.

Description

Lists all devices in the system unless you include any of the options to limit the devices listed.

• software - List only devices running this software
• vendor - List only devices with this vendor name
• type - List only devices of this type (Router, Switch, etc.)
• model - List only devices of this model ("2500 (3000 series)", BIG-IP, etc.)
• family - List only devices in this device family ("Cisco IOS", F5, etc.)
• group - List only devices in this device group
• disabled - List only devices that are unmanaged.
• pollexcluded - List only devices excluded from polling.
• ids - List only devices in this comma-separated list of IDs.
• hierarchy - List only devices in this hierarchy layer.
• host - List only devices with this host name
• ip - List only devices with this IP Address
• realm - List only devices in this realm
• startid - List devices starting with DeviceIDs greater than or equal to this one.
• limitcount - Return this many rows (maximum defaults to 10000).

SOAP API Format

list_device_data

List configuration and diagnostic data records for the specified device.

Description

• ip - a.b.c.d where 0 <= a,b,c,d <= 255. You may optionally prefix the IP with SITE: where SITE is the name of the Site the device is in.
• dataType - A string describing the type of device data record to list

SOAP API Format

list_device_family

List device families.

Description

Lists device families in the system.

• software - List only device families for devices running this software
• vendor - List only device families for devices with this vendor name
• type - List only device families for devices of this type (Router, Switch, etc.)
• model - List only device families for devices of this model ("2500 (3000 series)", BIG-IP, etc.)
• group - List only device families for devices in this device group

SOAP API Format

list_device_group

List device groups.

Description

Lists device groups in the system.

• software - List only device groups for devices running this software
• vendor - List only device groups for devices with this vendor name
• type - List only device groups for devices of this type (Router, Switch, etc.)
• model - List only device groups for devices of this model ("2500 (3000 series)", BIG-IP, etc.)
• family - List only device groups for devices in this device family ("Cisco IOS", F5, etc.)
• parent - List only device groups that are direct descendants of this parent device group name

SOAP API Format

list_device_id

list device IDs.

Description

Lists all device IDs in the system unless you include any of the options to limit the device IDs listed.

• software - List only devices running this software
• vendor - List only devices with this vendor name
• type - List only devices of this type (Router, Switch, etc.)
• model - List only devices of this model ("2500 (3000 series)", BIG-IP, etc.)
• family - List only devices in this device family ("Cisco IOS", F5, etc.)
• group - List only devices in this device group
• disabled - List only devices that are unmanaged.
• pollexcluded - List only devices excluded from polling.
• id - List only this device.
• host - List only devices with this host name
• ip - List only devices with this IP Address
• realm - List only devices in this realm
• hierarchy - List only devices with this hierarchy layer
• viewable_by - List only devices that are viewable by this user_ID

SOAP API Format

list_device_model

List device model names.

Description

Lists device model names in the system.

• software - List only device model names for devices running this software
• vendor - List only device model names for devices with this vendor name
• type - List only device model names for devices of this type (Router, Switch, etc.)
• family - List only device model names for devices in this device family ("Cisco IOS", F5, etc.)
• group - List only device model names for devices in this device group

SOAP API Format

list_device_software

List device software versions.

Description

Lists device software versions in the system.

• vendor - List only device software versions for devices with this vendor name
• type - List only device software versions for devices of this type (Router, Switch, etc.)
• model - List only device software versions for devices of this model ("2500 (3000 series)", BIG-IP, etc.)
• family - List only device software versions for devices in this device family ("Cisco IOS", F5, etc.)
• group - List only device software versions for devices in this device group

SOAP API Format

list_device_type

List device types.

Description

Lists device types in the system.

• software - List only device types for devices running this software
• vendor - List only device types for devices with this vendor name
• model - List only device types for devices of this model ("2500 (3000 series)", BIG-IP, etc.)
• family - List only device types for devices in this device family ("Cisco IOS", F5, etc.)
• group - List only device types for devices in this device group

SOAP API Format

list_device_vendor

List device manufacturers.

Description

Lists device manufacturers in the system.

• software - List only device manufacturers for devices running this software
• type - List only device manufacturers for devices of this type (Router, Switch, etc.)
• model - List only device manufacturers for devices of this model ("2500 (3000 series)", BIG-IP, etc.)
• family - List only device manufacturers for devices in this device family ("Cisco IOS", F5, etc.)
• group - List only device manufacturers for devices in this device group

SOAP API Format

list_deviceinfo

List all configs for which the DeviceInformation model can be shown.

Description

• ip - a.b.c.d where 0 <= a,b,c,d <= 255. You may optionally prefix the IP with SITE: where SITE is the name of the Site the device is in.
• host - A valid hostname
• fqdn - A valid Fully Qualified Domain Name
• deviceid - A device ID

SOAP API Format

list_diagnostic

List all configs for which the given diagnostic may be shown.

Description

• diagnostic - A diagnostic name
• ip - a.b.c.d where 0 <= a,b,c,d <= 255. You may optionally prefix the IP with SITE: where SITE is the name of the Site the device is in.
• host - A valid hostname
• fqdn - A valid Fully Qualified Domain Name
• deviceid - A device ID
• start - Display only those diagnostics stored on or after the given date. Values for this option may be in one of the following formats: YYYY-MM-DD HH:MM:SS e.g. 2002-09-06 12:30:00 YYYY-MM-DD HH:MM e.g. 2002-09-06 12:30 YYYY-MM-DD e.g. 2002-09-06 YYYY/MM/DD e.g. 2002/09/06 YYYY:MM:DD:HH:MM e.g. 2002:09:06:12:30 Or, one of: now, today, yesterday, tomorrow Or, in the format: e.g. 3 days ago is a positive integer. is one of: seconds, minutes, hours, days, weeks, months, years;. is one of: ago, before, later, after.
• end - Display only those diagnostics created on or before the given date. Values for this option have the same format as for the option -start.

SOAP API Format

list_drivers

List all drivers associated with a device.

Description

• ip - a.b.c.d where 0 <= a,b,c,d <= 255. You may optionally prefix the IP with SITE: where SITE is the name of the Site the device is in.
• host - A valid hostname
• fqdn - A valid Fully Qualified Domain Name
• deviceid - A device ID

SOAP API Format

list_event

List events.

Description

Lists all the events and system messages

• ip - a.b.c.d where 0 <= a,b,c,d <= 255. You may optionally prefix the IP with SITE: where SITE is the name of the Site the device is in.: Display only those events associated with the specified device.
• host - A valid hostname: Display only those events associated with the specified device.
• fqdn - A valid Fully Qualified Domain Name: Display only those events associated with the specified device.
• deviceid - A device ID
• type - A valid event type: Display only events of this type. Values for this option may one of the following: Approval No Longer Required Approval Request Approval Granted Approval Task Changed Approval Task Deleted Approval Denied Approval Task Timeout Approval Override Command Authorization Error Command Script Modified User Authentication Error Configuration Policy Added Configuration Policy Non-Compliance Configuration Policy Changed Configuration Policy Pattern Timeout Configuration Rule Added Configuration Rule Changed Device Access Failure Device Added Device Password Change Device Booted Device Command Script Failed Device Command Script Completed Successfully Device Configuration Change Device Configuration Change - No User Device Configuration Deployment Failure Device Configuration Deployment Device Data Failure Device Deleted Device Diagnostic Changed Device Diagnostic Failed Device Diagnostic Completed Successfully Device Flash Storage Running Low Group Modified Group Added Group Deleted Device Inaccessible Device Edited Last Used Device Password Changed Device Managed Device Missing from Import Device Permissions - Modified Device Reservation Conflict Device Snapshot Device Software Change Device Startup/Running Config Difference Device Unmanaged Diagnostic Modified Software Vulnerability Detected Email Report Saved External Directory Server Authentication Error License Almost Exceeded License Almost Expired License Exceeded License Expired Module Added Module Changed Module Removed Monitor Okay Monitor Error Device Permissions - New Device Device Password Change Failure Concurrent Telnet/SSH Session Override Reserved Device Configuration Changed Scheduled for Deploy Configuration Edited Scheduled for Deploy Password Modified Server Startup Session Data Captured Software Update Failed Software Update Succeeded Summary Reports Generated Pending Task Deleted Task Started Ticket Created User Login User Logout User Added User Deleted User Permission Changed User Message
• start - Display only events after this date. Values for this option may be in one of the following formats: YYYY-MM-DD HH:MM:SS e.g. 2002-09-06 12:30:00 YYYY-MM-DD HH:MM e.g. 2002-09-06 12:30 YYYY-MM-DD e.g. 2002-09-06 YYYY/MM/DD e.g. 2002/09/06 YYYY:MM:DD:HH:MM e.g. 2002:09:06:12:30 Or, one of: now, today, yesterday, tomorrow Or, in the format: e.g. 3 days ago is a positive integer. is one of: seconds, minutes, hours, days, weeks, months, years;. is one of: ago, before, later, after.
• end - Display only events before this date.

SOAP API Format

list_group_id

List all device groups or user groups viewable by userID.

Description

List all device groups or user groups viewable by a particular user.

• type - Type
• viewable_by - List only groups that are viewable by this user_ID

SOAP API Format

list_groups

List groups of the specified type; for a specific device or all groups in the system.

Description

• type - The type of the groups to be listed. "device" is currently the only valid argument to this option.
• ip - List all device groups containing the device with this IP address
• host - List all device groups containing the device with this hostname
• fqdn - List all device groups containing the device with this Fully Qualified Domain Name
• deviceid - List all device groups containing the device with this device ID
• parent - List all device groups that are children of the indicated parent group

SOAP API Format

list_icmp

List all configs for which the ICMPTest model may be shown.

Description

• ip - a.b.c.d where 0 <= a,b,c,d <= 255. You may optionally prefix the IP with SITE: where SITE is the name of the Site the device is in.
• host - A valid hostname
• fqdn - A valid Fully Qualified Domain Name
• deviceid - A device ID
• start - Display only those ICMPTest models stored on or after the given date. Values for this option may be in one of the following formats: YYYY-MM-DD HH:MM:SS e.g. 2002-09-06 12:30:00 YYYY-MM-DD HH:MM e.g. 2002-09-06 12:30 YYYY-MM-DD e.g. 2002-09-06 YYYY/MM/DD e.g. 2002/09/06 YYYY:MM:DD:HH:MM e.g. 2002:09:06:12:30 Or, one of: now, today, yesterday, tomorrow Or, in the format: e.g. 3 days ago is a positive integer. is one of: seconds, minutes, hours, days, weeks, months, years;. is one of: ago, before, later, after.
• end - Display only those ICMPTest models stored on or before the given date. Values for this option have the same format as for the option -start.

SOAP API Format

list_image

List images in database or device.

Description

Use -imageset option to list images in database, and -ip to list images in device

• ip - The device ip which the images list from.
• site - The partition site which the image belongs to. Will assume global if not specified.
• imageset - The imageset which images list from.

SOAP API Format

list_imageoption

List information for device which is not under management but in configuration data.

Description

List information for device which is not under management but in configuration data for software image management purpose.

• name - device property name to list.

SOAP API Format

list_imageset

List imageset in database.

Description

List imageset in database

• site - The partition site which the imageset belongs to. Will assume global if not specified.

SOAP API Format

list_int

List all configs for which the ShowInterfaces model may be shown.

Description

• ip - a.b.c.d where 0 <= a,b,c,d <= 255. You may optionally prefix the IP with SITE: where SITE is the name of the Site the device is in.
• host - A valid hostname
• fqdn - A valid Fully Qualified Domain Name
• deviceid - A device ID
• start - Display only those ShowInterfaces models stored on or after the given date. Values for this option may be in one of the following formats: YYYY-MM-DD HH:MM:SS e.g. 2002-09-06 12:30:00 YYYY-MM-DD HH:MM e.g. 2002-09-06 12:30 YYYY-MM-DD e.g. 2002-09-06 YYYY/MM/DD e.g. 2002/09/06 YYYY:MM:DD:HH:MM e.g. 2002:09:06:12:30 Or, one of: now, today, yesterday, tomorrow Or, in the format: e.g. 3 days ago is a positive integer. is one of: seconds, minutes, hours, days, weeks, months, years;. is one of: ago, before, later, after.
• end - Display only those ShowInterfaces models stored on or before the given date. Values for this option have the same format as for the option -start.

SOAP API Format

list_ip

List ip.

Description

Lists ip addresses for specific device.

• deviceip - The device's ip address a.b.c.d where 0 <= a,b,c,d <= 255. You may optionally prefix the IP with SITE: where SITE is the name of the Site the device is in.
• ip - a.b.c.d where 0 <= a,b,c,d <= 255. You may optionally prefix the IP with SITE: where SITE is the name of the Site the device is in.
• host - A valid hostname
• fqdn - A valid Fully Qualified Domain Name
• deviceid - A device ID

SOAP API Format

list_ip_all

List all secondary ip.

Description

List all secondary ip addresses in the system.

SOAP API Format

list_metadata

List all the custom data associated with a specific entry in a specific table.

Description

• table - Table the data is associated with
• associatedtableid - ID of the associated row from the table.

SOAP API Format

list_metadata_field

List all the custom data fields associated with a specific table.

Description

• table - Table the fields are associated with

SOAP API Format

list_module

List modules (or blades) in the system.

Description

• model - List only device modules matching this model number
• type - List only device modules matching this module description
• firmware - List only device modules matching this firmware version
• hardware - List only device modules matching this hardware revision
• memory - List only device modules with this amount of memory
• comment - List only device modules matching this comment
• ip - List only device modules on the device with this IP address
• host - List only device modules on the device with this hostname
• fqdn - List only device modules on the device with this Fully Qualified Domain Name
• deviceid - List only device modules on the device with this device ID
• group - List only device modules on all devices with this device group name

SOAP API Format

list_ospfneighbor

List all configs for which the ShowOSPFNeighbors model may be shown.

Description

• ip - a.b.c.d where 0 <= a,b,c,d <= 255. You may optionally prefix the IP with SITE: where SITE is the name of the Site the device is in.
• host - A valid hostname
• fqdn - A valid Fully Qualified Domain Name
• deviceid - A device ID
• start - Display only those ShowOSPFNeighbors models stored on or after the given date. Values for this option may be in one of the following formats: YYYY-MM-DD HH:MM:SS e.g. 2002-09-06 12:30:00 YYYY-MM-DD HH:MM e.g. 2002-09-06 12:30 YYYY-MM-DD e.g. 2002-09-06 YYYY/MM/DD e.g. 2002/09/06 YYYY:MM:DD:HH:MM e.g. 2002:09:06:12:30 Or, one of: now, today, yesterday, tomorrow Or, in the format: e.g. 3 days ago is a positive integer. is one of: seconds, minutes, hours, days, weeks, months, years;. is one of: ago, before, later, after.
• end - Display only those ShowOSPFNeighbors models stored on or before the given date. Values for this option have the same format as for the option -start.

SOAP API Format

list_partition

Show details for a single view.

Description

Show details for a single parition.

• viewname - The View Name to show.

SOAP API Format

list_policy_id

Lists IDs of all policies that apply to a given device

Description

• deviceid - device id

SOAP API Format

list_policy_rule

Lists all rules of a policy

Description

• policyid - policy id

SOAP API Format

list_port

List ports (or interfaces) for a specific device in the system.

Description

• ip - List all device ports on the device with this IP address
• host - List all device ports on the device with this hostname
• fqdn - List all device ports on the device with this Fully Qualified Domain Name
• deviceid - List all device ports on the device with this device ID

SOAP API Format

list_routing

List all routing tables for a device.

Description

• ip - a.b.c.d where 0 <= a,b,c,d <= 255. You may optionally prefix the IP with SITE: where SITE is the name of the Site the device is in.
• host - A valid hostname
• fqdn - A valid Fully Qualified Domain Name
• deviceid - A device ID
• start - Display only those routing tables stored on or after the given date. Values for this option may be in one of the following formats: YYYY-MM-DD HH:MM:SS e.g. 2002-09-06 12:30:00 YYYY-MM-DD HH:MM e.g. 2002-09-06 12:30 YYYY-MM-DD e.g. 2002-09-06 YYYY/MM/DD e.g. 2002/09/06 YYYY:MM:DD:HH:MM e.g. 2002:09:06:12:30 Or, one of: now, today, yesterday, tomorrow Or, in the format: e.g. 3 days ago is a positive integer. is one of: seconds, minutes, hours, days, weeks, months, years;. is one of: ago, before, later, after.
• end - Display only those routing tables stored on or before the given date. Values for this option have the same format as for the option -start.

SOAP API Format

list_rule_condition

Lists all conditions of a policy rule

Description

• ruleid - rule id

SOAP API Format

list_script

List command scripts, advanced scripts and/or diagnostics.

Description

• type - Type of the desired script or diagnostic - may be command, advanced or diagnostic
• scripttype - User defined script type (i.e. subcategory) - applies only to command scripts and advanced scripts
• name - Script name
• mode - Script mode - for command scripts and diagnostics the script's level of device access (such as Cisco IOS enable); for advanced scripts the device family (such as Cisco IOS)
• ids - List only scripts in this comma-separated list of IDs.
• sitename - Site Name of the site the script belongs to.

SOAP API Format

list_script_id

List command script IDs, advanced scripts and/or diagnostics.

Description

• type - Type of the desired script or diagnostic - may be command, advanced or diagnostic
• scripttype - User defined script type (i.e. subcategory) - applies only to command scripts and advanced scripts
• name - Script name
• mode - Script mode - for command scripts and diagnostics the script's level of device access (such as Cisco IOS enable); for advanced scripts the device family (such as Cisco IOS)
• id - Script ID

SOAP API Format

list_script_mode

List valid modes for commands scripts and diagnostics, and valid device families for advanced scripts, for all devices or a specified device.

Description

• ip - a.b.c.d where 0 <= a,b,c,d <= 255. You may optionally prefix the IP with SITE: where SITE is the name of the Site the device is in.
• host - A valid hostname
• fqdn - A valid Fully Qualified Domain Name
• deviceid - A device ID
• id - A device ID
• type - Type of the desired script or diagnostic - may be command, advanced or diagnostic

SOAP API Format

list_session

List all interceptor log records for a device.

Description

• ip - a.b.c.d where 0 <= a,b,c,d <= 255. You may optionally prefix the IP with SITE: where SITE is the name of the Site the device is in.
• host - A valid hostname
• fqdn - A valid Fully Qualified Domain Name
• deviceid - A device ID
• start - Display only those interceptor log records created on or after the given date. Values for this option may be in one of the following formats: YYYY-MM-DD HH:MM:SS e.g. 2002-09-06 12:30:00 YYYY-MM-DD HH:MM e.g. 2002-09-06 12:30 YYYY-MM-DD e.g. 2002-09-06 YYYY/MM/DD e.g. 2002/09/06 YYYY:MM:DD:HH:MM e.g. 2002:09:06:12:30 Or, one of: now, today, yesterday, tomorrow Or, in the format: e.g. 3 days ago is a positive integer. is one of: seconds, minutes, hours, days, weeks, months, years;. is one of: ago, before, later, after.
• end - Display only those interceptor log records created on or before the given date. Values for this option have the same format as for the option -start.

SOAP API Format

list_site

List all Sites in the system.

Description

Result includes the name of each site in the system, and the number of devices in each site.

SOAP API Format

list_sys_oids_all

List all sys oids supported by the system.

Description

List all sys oids in the system.

SOAP API Format

list_system_message

List system messages.

Description

Lists all system messages unless you include one of the options. Including one of the device options displays all system messages associated with the specified device.

• ip - a.b.c.d where 0 <= a,b,c,d <= 255. You may optionally prefix the IP with SITE: where SITE is the name of the Site the device is in.
• host - A valid hostname
• fqdn - A valid Fully Qualified Domain Name
• deviceid - A device ID
• start - Display only those system messages created on or after the given date. Values for this option may be in one of the following formats: YYYY-MM-DD HH:MM:SS e.g. 2002-09-06 12:30:00 YYYY-MM-DD HH:MM e.g. 2002-09-06 12:30 YYYY-MM-DD e.g. 2002-09-06 YYYY/MM/DD e.g. 2002/09/06 YYYY:MM:DD:HH:MM e.g. 2002:09:06:12:30 Or, one of: now, today, yesterday, tomorrow Or, in the format: e.g. 3 days ago is a positive integer. is one of: seconds, minutes, hours, days, weeks, months, years;. is one of: ago, before, later, after.
• end - Display only those system messages created on or before the given date. Values for this option have the same format as for the option -start.

SOAP API Format

list_task

Display a list of tasks.

Description

This command behaves differently depending on the options you give it. The command by itself returns a list of all tasks. Each option filters the returned list of tasks, causing it to return a subset of the total list.

• ip - a.b.c.d where 0 <= a,b,c,d <= 255. You may optionally prefix the IP with SITE: where SITE is the name of the Site the device is in.: Display only those tasks associated with the specified device.
• host - A valid hostname: Display only those tasks associated with the specified device.
• fqdn - A valid Fully Qualified Domain Name: Display only those tasks associated with the specified device.
• deviceid - A valid device ID: Display only those tasks associated with the specified device.
• start - YYYY:MM:DD:HH:mm: Display only those tasks whose schedule date falls on or after the given date.
• end - YYYY:MM:DD:HH:mm: Display only those tasks whose schedule date falls on or before the given date
• parentid - a task ID: Display only those tasks whose parent is the task specified by the given Task ID.
• status - (pending | succeeded | failed | running | paused | starting | waiting | synchronous | skipped | warning): Display only those tasks with the specified status.
• id - a task ID: Display the task with the given task ID.
• type - Task type: Display the specific type of task. Possible values: Take Snapshot Discover Driver Run ICMP Test Deploy Passwords Import Clean Devices after Import Deploy Config Resolve FQDN Configure Syslog Run Command Script Run Diagnostics Run External Application Synchronize Startup and Running Send Email Digest Clean Debug Log Files Update Device Software Backup Device Software Download Image from Cisco.com OS Analysis Email Report Run Software Upload Script Reboot Device Prepare Device Memory Check Policy Compliance Generate Summary Reports Data Pruning Run Device Script Multi-Task Project Delete ACLs Detect Network Devices Deduplication Deploy Remote Agent

SOAP API Format

list_task_all

List all tasks.

Description

Equivalent to "list task".

SOAP API Format

list_topology

List Device Information from Topology Data.

Description

• mac - Show only devices that have seen this MAC address (no colons)
• ip - Show only devices that have seen this IP Address

SOAP API Format

list_topology_graph

List probable Layer 1 topology data.

Description

• deviceids - A comma separated list of device IDs
• deviceportids - A comma separated list of device port IDs
• serverids - A comma separated list of server IDs
• serverportids - A comma separated list of server interface IDs
• deviceid - A device ID

SOAP API Format

list_topology_ip

List IP address Topology Data.

Description

• deviceip - The ip/hostname of the device for which to show IP topology data.
• portid - The port id for which to show IP topology data.
• notcurrent - Specify to limit output to only IP topology data that is no longer visible.
• type - Limit the IP data to a specific type.
• ip - a.b.c.d where 0 <= a,b,c,d <= 255. You may optionally prefix the IP with SITE: where SITE is the name of the Site the device is in.
• host - A valid hostname
• fqdn - A valid Fully Qualified Domain Name
• deviceid - A device ID

SOAP API Format

list_topology_mac

List MAC address Topology Data.

Description

• deviceip - The ip/hostname of the device for which to show MAC topology data.
• portid - The port id for which to show MAC topology data.
• notcurrent - Specify to limit output to only MAC topology data that is no longer visible.
• type - Limit the MAC data to a specific type.
• ip - a.b.c.d where 0 <= a,b,c,d <= 255. You may optionally prefix the IP with SITE: where SITE is the name of the Site the device is in.
• host - A valid hostname
• fqdn - A valid Fully Qualified Domain Name
• deviceid - A device ID

SOAP API Format

list_user

List all users.

Description

List all users known to the system.

SOAP API Format

list_user_id

List all users viewable by userID.

Description

List all users viewable by a particular user.

• viewable_by - List only users that are viewable by this user_ID

SOAP API Format

list_view

display the views defined within the system.

Description

Show the views defined within the system. This command takes no arguments.

SOAP API Format

list_vlan

Show the vlans and their associated Device Port ID on a device.

Description

• deviceip - The ip/hostname of the device for which to show vlans.
• ip - a.b.c.d where 0 <= a,b,c,d <= 255. You may optionally prefix the IP with SITE: where SITE is the name of the Site the device is in.
• host - A valid hostname
• fqdn - A valid Fully Qualified Domain Name
• deviceid - A device ID

SOAP API Format

list_vlan_ports

Show the ports on a given vlan, identified by its port id.

Description

• id - The port id of the vlan (provided in 'list vlan').

SOAP API Format

login

Authenticate against the NA SOAP API and start an API session

Description

• username - NA username
• password - NA password
• host - URL of NA server (defaults to localhost:@JNP_PORT@)

SOAP API Format

<SOAP-ENV:Envelope xmlns:xsd="http://www.w3.org/2001/XMLSchema"

    xmlns:SOAP-ENV="http://schemas.xmlsoap.org/soap/envelope/"

    xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance">

  <SOAP-ENV:Body>

    <nas:login xmlns:nas="http://opsware.com/nas/">

      <nas:password xsi:type="xsd:string">CWNCM password</nas:password>

      <nas:username xsi:type="xsd:string">CWNCM username</nas:username>

      <!-- Optional arguments -->

      <nas:host xsi:type="xsd:string">CWNCM host URL</nas:host>

    </nas:login>

  </SOAP-ENV:Body>

</SOAP-ENV:Envelope>

logout

End the NA SOAP API session

Description

• sessionid - NA SOAP API Session ID

SOAP API Format

mod_advanced_script

Modify an existing advanced script.

Description

Modify the indicated advanced script. The desired script can be specified by ID or name. If more than one name match occurs, then an error will be reported and you must specify the unique script desired by ID.

• id - ID of the advanced script to edit
• name - Name of the advanced script to edit
• newname - New name for the script being modified
• description - New description for the script being modified
• scripttype - New script type (i.e. user defined subcategory)
• family - New device family for the script being modified
• language - New language for the script being modified - must be a supported language such as Expect or Perl
• parameters - New command line parameters for the script being modified
• script - New script text
• sitename - Site name

SOAP API Format

mod_authentication

Modify device password information.

Description

This command can modify passwords on a specific device, across all devices in a device group, or merely update what the system knows of the device's password information. When using this command to modify passwords on a device or device group, the modification operation is actually a scheduled task.

• loc - The location to which password information should be written. Valid values for this argument are "db", "device", and "group". "db" tells the command that password information should be changed only in the system's database. "device" tells the command that the password changes should be made on the device as well and "group" performs the same function as "device" but across all devices in the group.
• ip - a.b.c.d where 0 <= a,b,c,d <= 255. You may optionally prefix the IP with SITE: where SITE is the name of the Site the device is in.: An existing device to which this password information should apply.
• host - A valid hostname: An existing device to which this password information should apply.
• fqdn - A valid Fully Qualified Domain Name: An existing device to which this password information should apply.
• deviceid - A valid device ID: An existing device to which this password information should apply.
• snmpro - When used in conjunction with -loc db, this argument is taken as a single community string understood by the system as THE read only community string for the device or network. When used in conjunction with -loc device, this argument is taken as a comma-seperated list of read only community strings to be, either set on the device, or appended to an existing list of read only community strings (depends on whether or not the -appendsnmpro flag was supplied.)
• snmprw - When used in conjunction with -loc db, this argument is taken as a single community string understood by the system as THE read write community string for the device or network. When used in conjunction with -loc device, this argument is taken as a comma-seperated list of read write community strings to be, either set on the device, or appended to an existing list of read write community strings (depends on whether or not the -appendsnmprw flag was supplied.)
• snmpv3user - When used in conjunction with -loc db, this argument is taken as the username for snmpv3 access.
• snmpv3authpw - When used in conjunction with -loc db, this argument is taken as the authentication password for snmpv3 access.
• snmpv3encryptpw - When used in conjunction with -loc db, this argument is taken as the encryption password for snmpv3 access.
• user - Username.
• passwd - Password.
• enableuser - ADDITIONAL username to get to "enable" mode.
• enablepasswd - ADDITIONAL password to get to "enable" mode.
• connectionmethods - The methods used by the system to connect to devices. Can be telnet, serial_direct, or SSH.
• accessvariables - To override variables in the script, such as prompts.
• start - YYYY:MM:DD:HH:mm. The first date on which the task will run. Use this option only if the argument to the -loc flag is "device".
• appendsnmpro - Supply this option if read only community strings should be appended to any existing on the device. Use this option only if the argument to the -loc flag is "device".
• appendsnmprw - Supply this option if read write community strings should be appended to any existing on the device. Use this option only if the argument to the -loc flag is "device".
• sync - Indicates that the command should return only after the password change task is complete. Do not use this option with -start.
• group - The group name for performing this command across all devices in a group.
• site - The site partition this rule belongs to. Default to be global
• rulename - The password rule name to apply the access variables to
• rulehostname - Hostname, the rule applies to
• ruledevicegroup - Device group name, the rule applies to
• iprangestart - IP range start (range), the rule applies to
• iprangeend - IP range end (range), the rule applies to

SOAP API Format

mod_command_script

Modify an existing command script.

Description

Modify the indicated command script. The desired script can be specified by ID or name. If more than one name match occurs, then an error will be reported and you must specify the unique script desired by ID.

• id - ID of the command script to edit
• name - Name of the command script to edit
• newname - New name for the script being modified
• description - New description for the script being modified
• scripttype - New script type (i.e. user defined subcategory)
• mode - New command script mode
• driver - New list of applicable drivers - provided as a comma separated list of internal driver names
• script - New script text
• sitename - Site Name

SOAP API Format

mod_device

Modify the properties of a device.

Description

• ip - a.b.c.d where 0 <= a,b,c,d <= 255. You may optionally prefix the IP with SITE: where SITE is the name of the Site the device is in.
• host - A valid hostname
• fqdn - A valid Fully Qualified Domain Name
• deviceid - A device ID
• hostname - The device's new host name
• comment - Additional information regarding the device.
• description - The descriptive name of the device (informational only).
• model - The device's model (such as 2620).
• vendor - The device's vendor (such as Cisco).
• domain - A fully qualified domain name (such as www.google.com).
• serial - The device's serial number.
• asset - The device's asset tag.
• location - The device's location.
• unmanaged - 0: Mark this device as managed by the system. 1: Mark this device to be unmanaged by the system.
• nopoll - 0: Mark this device to be polled for changes. 1: Mark this device as not to be polled for changes.
• newIP - a.b.c.d where 0 <= a,b,c,d <= 255. You may optionally prefix the IP with SITE: where SITE is the name of the Site the device will be put in. This is the new IP address of the device.
• consoleip - a.b.c.d where 0 <= a,b,c,d <= 255. You may optionally prefix the IP with REALM_NAME:, where REALM_NAME is the name of the Realm the address is in.
• consoleport - The port number
• tftpserverip - a.b.c.d where 0 <= a,b,c,d <= 255
• natip - a.b.c.d where 0 <= a,b,c,d <= 255. You may optionally prefix the IP with REALM_NAME:, where REALM_NAME is the name of the Realm the address is in.
• customname - The custom field name
• customvalue - The custom field value
• useconsoleserver - true, if the device uses a console server. false, if the device does not.
• accessmethods - A comma-separated list of access methods, or "none". The set of access methods: {telnet, ssh, rlogin, SCP, FTP, TFTP, SNMP, snmp_noauthnopriv, snmp_authnopriv, snmp_authpriv}.
• hierarchylayer - This device attribute is used in diagramming. When you config a network diagram, you can select which hierarchy layers on which to filter. Valid values include: (core, distribution, access, edge and "layer not set").

SOAP API Format

mod_diagnostic

Modify an existing custom diagnostic script.

Description

Modify the indicated diagnostic script. The desired diagnostic can be specified by ID or name. If more than one name match occurs, then an error will be reported and you must specify the unique diagnostic desired by ID.

• id - ID of the diagnostic to edit
• name - Name of the diagnostic to edit
• newname - New name for the diagnostic being modified
• description - New description for the diagnostic being modified
• mode - New command script mode
• driver - New list of applicable drivers - provided as a comma separated list of internal driver names
• script - New diagnostic script text
• sitename - Site name

SOAP API Format

mod_group

Modify a group.

Description

Modify the comments associated with and/or the name of a group.

• type - The type of the group. "device" is currently the only valid argument to this option.
• name - The name of the group to be modified.
• newname - The new name for the modified group. Do not use this option unless you also use -name.
• comment - Additional information regarding the group.
• customname - The custom field name
• customvalue - The custom field value
• shared - 1 if the group is shared, 0 if it is not.

SOAP API Format

mod_ip

Modify the properties of a ip.

Description

• ipvalue - The ip value a.b.c.d where 0 <= a,b,c,d <= 255
• deviceip - The device's ip address a.b.c.d where 0 <= a,b,c,d <= 255. You may optionally prefix the IP with SITE: where SITE is the name of the Site the device is in.
• ip - a.b.c.d where 0 <= a,b,c,d <= 255. You may optionally prefix the IP with SITE: where SITE is the name of the Site the device is in.
• host - A valid hostname
• fqdn - A valid Fully Qualified Domain Name
• deviceid - A device ID
• comment - Additional information regarding the device.
• usetoaccess - Use this IP Value to access its device, 0 - yes, 1 - no, default - no

SOAP API Format

mod_metadata

Modify an existing piece of custom data associated with a specific field and associated entity.

Description

• metadataid - ID of the custom data to delete
• fieldid - Field ID the data is to be associated with
• data - New data to be associated
• associatedtableid - ID of the associated row the data coresponds to

SOAP API Format

mod_metadata_field

Used to modify an existing custom data field.

Description

• fieldid - ID of the field to modify
• fieldname - New name of the field
• fieldvalues - List of comma separated values that the field is restricted to. If not specified, the value for this field is not restricted
• inuse - Turns the field on or off. 1 is on, 0 is off. When the field is off, it will not be displayed with the other custom fields.
• flags - Used for allowing HTML in the field value. 1 is allow, 0 is disallow. If disallowed, HTML will be escaped for displaying.
• associatedtable - The table to associate this field with

SOAP API Format

mod_module

Modify a module's properties.

Description

• id - The ID of a module
• comment - Additional information about the module.
• customname - The custom field name
• customvalue - The custom field value

SOAP API Format

mod_partition

Modify a partition.

Description

• name - The name of the partition to be modified.
• newname - The new name for the modified partition. Do not use this option unless you also use -name.
• comment - Additional information regarding the partition.

SOAP API Format

mod_port

Modify a port's properties.

Description

• id - The ID of a port
• comment - Additional information about the port.
• customname - The custom field name
• customvalue - The custom field value

SOAP API Format

mod_task

Modify a scheduled task.

Description

• id - The task ID of the task to modify.
• comment - Additional information about the task.
• retryInterval - The number of seconds between retries.
• expensive - Mark the task as expensive. Do not use this option with -notexpensive.
• notexpensive - Mark the task as not expensive. Do not use this option with -expensive.
• days - This argument differs depending on the task. For weekly tasks, -days should be a comma-separated list of weekdays. Each item in the list is a day of the week upon which the task should be run. Valid weekdays are: sun, mon, tue, wed, thur, fri, sat. For monthly tasks, -days should be a single integer between 1 and 31, corresponding to the day of the month upon which the task should be run.
• retryCount - The number of times to retry the task if it fails.
• repeatType - The metric by which a task repeats. Valid values are 1: once, 2: periodically, 3: daily, 4: weekly, 5: monthly. If you modify this value, then modify -repeatInterval or -days accordingly.
• duration - Estimated duration the task will run(in minutes)
• start - YYYY:MM:DD:HH:mm. The first date the task will run. The string "now" means the current time. The string "tomorrow" means 24 hours from the current time.
• repeatInterval - This option differs depending on the task. For Periodic tasks, this is the period in minutes. For Monthly tasks, each bit of the integer (except the last) represents a day, but we recommend using the -days option to modify the days on which a monthly task runs. This option is invalid with all other tasks.
• approve - Approve the task
• reject - Reject the task
• override - Override the approval requirement
• customname - The custom field name
• customvalue - The custom field value
• sessionlog - If true a complete session log will be saved with this task.

SOAP API Format

mod_topology_graph

Modify topology data.

Description

• type - The topology data type, typically "phy_inferred" for L1
• data - The topology data value, typically a MAC address (without colons)
• deviceid - The source device ID
• deviceportid - The source device port ID
• remotedeviceid - The destination device ID
• remotedeviceportid - The destination device port ID
• serverid - The destination server ID
• serverportid - The destination server port ID

SOAP API Format

mod_unmanaged_device

Modify the properties of an unmanaged device.

Description

• ip - a.b.c.d where 0 <= a,b,c,d <= 255. You may optionally prefix the IP with SITE: where SITE is the name of the Site the device is in.
• comment - Additional information regarding the device.

SOAP API Format

mod_user

Modify a user's properties.

Description

• u - Username
• p - Password
• fn - First name
• ln - Last name
• email - Email address
• priv - User Privilege (1=Limited Access,2=Full Access,3=Power User,4=Admin)
• newusername - New username for this user.
• aaausername - AAA username for this user.
• aaapassword - AAA password for this user.
• useaaaloginforproxy - Whether to user AAA logins for the Proxy Interface for this user (yes|no).
• extauthfailover - Whether to allow external auth failover for this user (yes|no).
• customname - The custom field name
• customvalue - The custom field value
• status - enable or disable
• view1partition - partition the user belongs to in the first view
• view2partition - partition the user belongs to in the second view
• view3partition - partition the user belongs to in the third view

SOAP API Format

mod_version

Description

SOAP API Format

passwd

Change current user's password.

Description

Causes the current user's password to be changed.

• oldpwd - youroldpassword
• newpwd - yournewpassword

SOAP API Format

pause_polling

Stop polling.

Description

Stop polling devices for configuration changes.

SOAP API Format

ping

Run a ping command on a device.

Description

Causes a series of ping commands to be executed on a device. One ping command is executed for each target host specified. This series of commands may by run on the device immediately, or scheduled to run sometime in the future. Via this command, the task scheduled can be set to repeat periodically. Note that if not scheduled as a task, this command may take some time to complete.

• source - Can be an IP address (a.b.c.d where 0 <= a,b,c,d <= 255), or a valid hostname, or a valid Fully Qualified Domain Name.
• sourcegroup - A valid group name. Exactly one of -source or -sourcegroup must be specified.
• dest - A comma seperated list of devices. Devices may be specified in any way that is understood by the ping program on the device specified by the option "-source".
• rep - (#min | #:# | #days | #weeks | #months) where # is a positive integer. #:# is hours:minutes, the two integers don't have to be the same. This option should not be used unless -async is also supplied.
• async - Indicates that the ping operation should be scheduled on the system as a task. The start time for the task will be immediatly unless an alternate start data is provided by means of the -start option.
• start - YYYY:MM:DD:HH:mm. The date on which the task will first be run. This option should not be used unless -async is also supplied.

SOAP API Format

reload_content

Description

Load any new content packs (such as scripts or policies) that have been installed on the server since the last time it was restarted or content was reloaded.

SOAP API Format

reload_drivers

Description

Causes the server to reload all installed driver files.

• force - Force drivers to be reloaded even when there is error

SOAP API Format

reload_server_options

Description

Causes the server to reload config variables from all config files.

SOAP API Format

replication_start

Description

SOAP API Format

replication_status

Description

SOAP API Format

replication_stop

Description

SOAP API Format

replication_sync

Description

SOAP API Format

resume_polling

Resume polling.

Description

Resume polling devices for configuration changes.

SOAP API Format

run_advanced_script

Run an existing advanced script against a device or group of devices.

Description

Runs an existing advanced script, specified by name, against a device or group of devices. The proper variant of the script will be applied to each device. If no variant of the script supports a given device, that device will be skipped. The script is run as a system task.

• ip - a.b.c.d where 0 <= a,b,c,d <= 255. You may optionally prefix the IP with SITE: where SITE is the name of the Site the device is in.
• host - A valid hostname
• fqdn - A valid Fully Qualified Domain Name
• deviceid - A device ID
• group - A valid group name. Either a device or a group must be specified, but not both (exactly one of -ip, -hostname, -fqdn or -group must be specified).
• name - Name of the advanced script to run
• parameters - Command line parameters for the advanced script to run
• variables - A list of variables to be replaced in the script - provided as a list of name=value pairs, separated by commas. Values can be surrounded in single-quotes ('). Within a quoted value, a single-quote can be embedded with two single-quote characters. Example: "variable1=value1,varable2='this is ''value 2'''"
• start - YYYY:MM:DD:HH:mm. The first date on which the task will run.
• rep - (#min | #:# | #days | #weeks | #months) where # is a positive integer. #:# is hours:minutes--the two integers do not have to be the same. Do not use this option with -sync.
• sync - Indicates the command should return only after the snapshot retrieval task is complete. Do not use this option with -rep or -start.
• nowait - Indicates that the task should not wait if there is another task currently running against the same device.
• comment - An optional comment about the snapshot.
• presnapshot - If false, this indicates that the snapshot that runs before the script should be skipped.
• postsnapshot - If false, this indicates that the snapshot that runs after the script should be skipped. If "task", this indicates that snapshot after the script should run as a separate task.

SOAP API Format

run_checkdb

Check the database for potential conflicts and optionally fix them.

Description

The scan for conflicts will consist of known field issuses and their resolutions. It is not all-inclusive

• verbose - Display verbose output, including SQL that would be used to fix the problems.
• fix - Flag to fix discovered problems

SOAP API Format

run_command_script

Run an existing command script against a device or group of devices.

Description

Runs an existing command script, specified by name, against a device or group of devices. The proper variant of the script will be applied to each device. If no variant of the script supports a given device, that device will be skipped. The script is run as a system task.

• ip - a.b.c.d where 0 <= a,b,c,d <= 255. You may optionally prefix the IP with SITE: where SITE is the name of the Site the device is in.
• host - A valid hostname
• fqdn - A valid Fully Qualified Domain Name
• deviceid - A device ID
• group - A valid group name. Either a device or a group must be specified, but not both (exactly one of -ip, -hostname, -fqdn or -group must be specified).
• name - Name of the command script to run
• variables - A list of variables to be replaced in the script - provided as a list of name=value pairs, separated by commas. Values can be surrounded in single-quotes ('). Within a quoted value, a single-quote can be embedded with two single-quote characters. Example: "variable1=value1,varable2='this is ''value 2'''"
• linebyline - Indicates that line by line deployment is preferred, rather than file-based deployment
• start - YYYY:MM:DD:HH:mm. The first date on which the task will run.
• rep - (#min | #:# | #days | #weeks | #months) where # is a positive integer. #:# is hours:minutes--the two integers do not have to be the same. Do not use this option with -sync.
• sync - Indicates the command should return only after the snapshot retrieval task is complete. Do not use this option with -rep or -start.
• nowait - Indicates that the task should not wait if there is another task currently running against the same device.
• comment - An optional comment about the snapshot.
• presnapshot - If false, this indicates that the snapshot that runs before the script should be skipped.
• postsnapshot - If false, this indicates that the snapshot that runs after the script should be skipped. If "task", this indicates that snapshot after the script should run as a separate task.

SOAP API Format

run_diagnostic

Run a diagnostic on a device.

Description

Run the specified diagnostic on a specified device either right away, or at some point in the future. The run diagnostic operation is actually a scheduled task.

• ip - a.b.c.d where 0 <= a,b,c,d <= 255. You may optionally prefix the IP with SITE: where SITE is the name of the Site the device is in.
• host - A valid hostname
• fqdn - A valid Fully Qualified Domain Name
• deviceid - A device ID
• group - A name of a device group (mutually exclusive with -ip, -host, or -fqdn)
• diagnostic - A diagnostic to run. Built-in diagnostics are 'NA Routing Table', 'NA Interfaces' and 'NA OSPF Neighbors'.
• rep - (#min | #:# | #days | #weeks | #months) where # is a positive integer. #:# is hours:minutes--the two integers do not have to be the same. Do not use this option with -sync.
• start - YYYY:MM:DD:HH:mm. The first date on which the task will run. Do not use this option with -sync.
• sync - Indicates that the command should return only after the deploy task is complete. Do not use this option with -start.
• comment - An optional comment about the diagnostic.
• duration - A number concatenated with a units signifier. Valid signifiers are m (minutes), h (hours), d (days), w (weeks). If this option is not provided, the duration for the task is set to 60 minutes.
• sessionlog - If true a complete session log will be saved with this task.
• customname - The custom field name.
• customvalue - The custom field value.
• retryInterval - The number of seconds between retries.
• retryCount - The number of times to retry the task if it fails.

SOAP API Format

run_external_application

Execute a command.

Description

Runs a NA task which spawns a new process that executes a command external to NA.

• app - The command to execute.
• start - YYYY:MM:DD:HH:mm The time when the command will be executed. Do not use this option with -sync.
• rep - (#min | #:# | #days | #weeks | #months) where # is a positive integer. #:# is hours:minutes--the two integers do not have to be the same. Do not use this option with -sync.
• sync - Indicates that the CLI command should return only after the task is complete. Do not use this option with -start.
• comment - Comments to be attached to the task that runs to execute the command.
• startdir - The working directory of the process in which the command is executed.
• resultfile - The file to contain the output of the command.
• errorifnonzero - If true the task will be marked FAILED or WARNING if the command returns a non zero result code.

SOAP API Format

run_gc

Run the garbage collector.

Description

Recycle unused objects to increase the amount of free memory.

SOAP API Format

run_internal_test

Description

SOAP API Format

run_script

Run a command script on a device.

Description

Run the specified command script on a specified device either right away, or at some point in the future. The run script operation is actually a scheduled task. If no mode is specified the first supported enable, supervisor, provisioning or root mode will be used.

• ip - a.b.c.d where 0 <= a,b,c,d <= 255. You may optionally prefix the IP with SITE: where SITE is the name of the Site the device is in.
• host - A valid hostname
• fqdn - A valid Fully Qualified Domain Name
• deviceid - A device ID
• group - A name of a device group (mutually exclusive with -ip, -host, or -fqdn)
• mode - A command script mode to run the script in.
• script - A script to run, may separate commands with '\n'. Commands that require multiple entries before returning to the device prompt can separate each entry with '\\r\\n'.
• rep - (#min | #:# | #days | #weeks | #months) where # is a positive integer. #:# is hours:minutes--the two integers do not have to be the same. Do not use this option with -sync.
• start - YYYY:MM:DD:HH:mm. The first date on which the task will run. Do not use this option with -sync.
• sync - Indicates that the command should return only after the deploy task is complete. Do not use this option with -start.
• nowait - Indicates that the task should not wait if there is another task currently running against the same device.
• comment - An optional comment about the script being run.
• presnapshot - If false, this indicates that the snapshot that runs before the script should be skipped.
• postsnapshot - If false, this indicates that the snapshot that runs after the script should be skipped. If "task", this indicates that snapshot after the script should run as a separate task.
• disablesessionlogging - Indicates that the session should not be logged.

SOAP API Format

schedule_task

Description

SOAP API Format

schedule_task_daily

Description

SOAP API Format

schedule_task_monthly

Description

SOAP API Format

schedule_task_periodic

Description

SOAP API Format

schedule_task_weekly

Description

SOAP API Format

show_access

Display a device access record.

Description

• id - Specifies a device access record. Think of this as a "device access record ID".

SOAP API Format

show_acl

Show ACL.

Description

Displays the device ACL in the system including Script and Application.

• id - List only ACLs with this deviceaclid

SOAP API Format

show_basicip

Show a BasicIP model.

Description

If the -ip flag is given, show the BasicIP model for the most recent config for the specified device. If the -id flag is given, show the BasicIP model for the specified config. Include either the -id or -ip option, but not both.

• ip - a.b.c.d where 0 <= a,b,c,d <= 255. You may optionally prefix the IP with SITE: where SITE is the name of the Site the device is in.
• host - A valid hostname
• fqdn - A valid Fully Qualified Domain Name
• deviceid - A device ID
• id - A config ID

SOAP API Format

show_config

Show the contents of a config.

Description

• id - The ID of a config
• mask - Mask out sensitive information such as device passwords

SOAP API Format

show_configlet

Show the configlet inbetween start and end pattern.

Description

• ip - List all device ports on the device with this IP address
• host - List all device ports on the device with this hostname
• fqdn - List all device ports on the device with this Fully Qualified Domain Name
• deviceid - List all device ports on the device with this device ID
• start - Block start pattern for the configlet
• end - Block end pattern for the congfiglet
• type - Type (helper) of the configlet

SOAP API Format

show_device

Show a device's properties.

Description

• ip - a.b.c.d where 0 <= a,b,c,d <= 255. You may optionally prefix the IP with SITE: where SITE is the name of the Site the device is in.
• host - A valid hostname
• fqdn - A valid Fully Qualified Domain Name
• deviceid - A device ID
• id - A device ID
• nodeuuid - A NNM node Uuid

SOAP API Format

show_device_config

Show the config most recently retrieved from the specified device.

Description

• ip - a.b.c.d where 0 <= a,b,c,d <= 255. You may optionally prefix the IP with SITE: where SITE is the name of the Site the device is in.
• host - A valid hostname
• fqdn - A valid Fully Qualified Domain Name
• deviceid - A device ID

SOAP API Format