Guest

CiscoWorks Network Compliance Manager

SOAP API Reference Guide for CiscoWorks Network Compliance Manager 1.3

CWNCM 1.3.SP1 SOAP API


SOAP API Reference for Network Compliance Manager 1.3.SP1

Document Version 1.3.SP1_001


Part Number: OL-10255-03

THE SPECIFICATIONS AND INFORMATION REGARDING THE PRODUCTS IN THIS MANUAL ARE SUBJECT TO CHANGE WITHOUT NOTICE. ALL STATEMENTS, INFORMATION, AND RECOMMENDATIONS IN THIS MANUAL ARE BELIEVED TO BE ACCURATE BUT ARE PRESENTED WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED. USERS MUST TAKE FULL RESPONSIBILITY FOR THEIR APPLICATION OF ANY PRODUCTS.

THE SOFTWARE LICENSE AND LIMITED WARRANTY FOR THE ACCOMPANYING PRODUCT ARE SET FORTH IN THE INFORMATION PACKET THAT SHIPPED WITH THE PRODUCT AND ARE INCORPORATED HEREIN BY THIS REFERENCE. IF YOU ARE UNABLE TO LOCATE THE SOFTWARE LICENSE OR LIMITED WARRANTY, CONTACT YOUR CISCO REPRESENTATIVE FOR A COPY.

The Cisco implementation of TCP header compression is an adaptation of a program developed by the University of California, Berkeley (UCB) as part of UCB's public domain version of the UNIX operating system. All rights reserved. Copyright � 1981, Regents of the University of California.

NOTWITHSTANDING ANY OTHER WARRANTY HEREIN, ALL DOCUMENT FILES AND SOFTWARE OF THESE SUPPLIERS ARE PROVIDED "AS IS" WITH ALL FAULTS. CISCO AND THE ABOVE-NAMED SUPPLIERS DISCLAIM ALL WARRANTIES, EXPRESSED OR IMPLIED, INCLUDING, WITHOUT LIMITATION, THOSE OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT OR ARISING FROM A COURSE OF DEALING, USAGE, OR TRADE PRACTICE.

IN NO EVENT SHALL CISCO OR ITS SUPPLIERS BE LIABLE FOR ANY INDIRECT, SPECIAL, CONSEQUENTIAL, OR INCIDENTAL DAMAGES, INCLUDING, WITHOUT LIMITATION, LOST PROFITS OR LOSS OR DAMAGE TO DATA ARISING OUT OF THE USE OR INABILITY TO USE THIS MANUAL, EVEN IF CISCO OR ITS SUPPLIERS HAVE BEEN ADVISED OF THE POSSIBILITY OF SUCH DAMAGES.

CCSP, CCVP, the Cisco Square Bridge logo, Follow Me Browsing, and StackWise are trademarks of Cisco Systems, Inc.; Changing the Way We Work, Live, Play, and Learn, and iQuick Study are service marks of Cisco Systems, Inc.; and Access Registrar, Aironet, BPX, Catalyst, CCDA, CCDP, CCIE, CCIP, CCNA, CCNP, Cisco, the Cisco Certified Internetwork Expert logo, Cisco IOS, Cisco Press, Cisco Systems, Cisco Systems Capital, the Cisco Systems logo, Cisco Unity, Enterprise/Solver, EtherChannel, EtherFast, EtherSwitch, Fast Step, FormShare, GigaDrive, GigaStack, HomeLink, Internet Quotient, IOS, IP/TV, iQ Expertise, the iQ logo, iQ Net Readiness Scorecard, LightStream, Linksys, MeetingPlace, MGX, the Networkers logo, Networking Academy, Network Registrar, Packet, PIX, Post-Routing, Pre-Routing, ProConnect, RateMUX, ScriptShare, SlideCast, SMARTnet, The Fastest Way to Increase Your Internet Quotient, and TransPath are registered trademarks of Cisco Systems, Inc. and/or its affiliates in the United States and certain other countries.

All other trademarks mentioned in this document or Website are the property of their respective owners. The use of the word partner does not imply a partnership relationship between Cisco and any other company. (0601R)

SOAP versus Web Services

This document descirbes the SOAP API and the formats used to interact with this API. If you wish to use the Web Services Description Language file that is included with this installation, you can use this document as a reference for the parameters and commands, but the sample envelopes will be slightly different than those sent by a tool which uses the WSDL file. The SOAP API described in this document is a pure SOAP implementation that is used by many existing applications, including the client tools that come with this product. To support those users who wish to use the convenience of a WSDL file, a file was created that works with several toolsets, but the interaction had to be changed slightly from the original SOAP API to ensure maximum compatibility. The sample envelopes for web services are not published in this document since they are not of great importance to someone using a WSDL file. Programmers looking to parse and manipulate their own SOAP packets should use the examples in this document, not the WSDL file.

For those looking to use the Web Services Description Language file, look here.


Contents

Requests

Responses

activate_device
add_advanced_script
add_authentication
add_command_script
add_device
add_device_to_group
add_diagnostic
add_event
add_event_rule
add_group
add_group_to_parent_group
add_image
add_imageoption
add_ip
add_metadata
add_metadata_field
add_parent_group
add_partition
add_snmp_trap_config
add_system_message
add_user
add_user_to_group
annotate_access
annotate_config
assign_driver
configure_syslog
deactivate_device
del_access
del_authentication
del_device
del_device_data
del_device_from_group
del_drivers
del_event
del_group
del_group_from_parent_group
del_ip
del_metadata
del_metadata_field
del_partition
del_script
del_session
del_system_message
del_task
del_user
del_user_from_group
delete_image
deploy_config
deploy_image
diff_config
disable_device
discover_driver
discover_drivers
enable_device
generate_stacktrace
get_snapshot
import
list_access
list_access_all
list_acl
list_agvalues
list_all_drivers
list_authentication
list_basicip
list_config
list_config_all
list_config_id
list_custom_data_definition
list_device
list_device_data
list_device_family
list_device_group
list_device_id
list_device_model
list_device_software
list_device_type
list_device_vendor
list_deviceinfo
list_diagnostic
list_drivers
list_event
list_group_id
list_groups
list_icmp
list_image
list_imageoption
list_imageset
list_int
list_ip
list_ip_all
list_metadata
list_metadata_field
list_module
list_ospfneighbor
list_partition
list_policy_id
list_policy_rule
list_port
list_routing
list_rule_condition
list_script
list_script_id
list_script_mode
list_session
list_site
list_sys_oids_all
list_system_message
list_task
list_task_all
list_topology
list_topology_graph
list_topology_ip
list_topology_mac
list_user
list_user_id
list_view
list_vlan
list_vlan_ports
login
logout
mod_advanced_script
mod_authentication
mod_command_script
mod_device
mod_diagnostic
mod_group
mod_ip
mod_metadata
mod_metadata_field
mod_module
mod_partition
mod_port
mod_task
mod_topology_graph
mod_unmanaged_device
mod_user
mod_version
passwd
pause_polling
ping
reload_content
reload_drivers
reload_server_options
replication_start
replication_status
replication_stop
replication_sync
resume_polling
run_advanced_script
run_checkdb
run_command_script
run_diagnostic
run_external_application
run_gc
run_internal_test
run_script
schedule_task
schedule_task_daily
schedule_task_monthly
schedule_task_periodic
schedule_task_weekly
show_access
show_acl
show_basicip
show_config
show_configlet
show_device
show_device_config
show_device_family
show_device_latest_diff
show_deviceinfo
show_diagnostic
show_driver
show_event
show_group
show_icmp
show_int
show_ip
show_latest_access
show_metadata
show_metadata_field
show_module
show_ospfneighbor
show_permission
show_policy
show_policy_compliance
show_policy_rule
show_polling_status
show_port
show_routing
show_rule_condition
show_script
show_server_option
show_session
show_session_commands
show_snapshot
show_system_message
show_task
show_topology
show_user
show_version
stop_task
stop_task_all
synchronize
test_config
test_software
test_view
traceroute
undeploy_image
update_dynamic_group
login response
text response
result set response

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


<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:activate_device xmlns:nas="http://opsware.com/nas/">

      <nas:sessionid xsi:type="xsd:string">session id from login</nas:sessionid>

      <nas:ip xsi:type="xsd:string">ipaddress</nas:ip>

      <!-- Note: host or fqdn can be sent instead of ip -->

    </nas:activate_device>

  </SOAP-ENV:Body>

</SOAP-ENV:Envelope>


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


<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:add_advanced_script xmlns:nas="http://opsware.com/nas/">

      <nas:sessionid xsi:type="xsd:string">session id from login</nas:sessionid>

      <nas:driver xsi:type="xsd:string"></nas:driver>

      <nas:language xsi:type="xsd:string">script language</nas:language>

      <nas:name xsi:type="xsd:string">name</nas:name>

      <nas:script xsi:type="xsd:string">script</nas:script>

      <nas:type xsi:type="xsd:string">advanced</nas:type>

      <!-- Optional arguments -->

      <nas:description xsi:type="xsd:string">description</nas:description>

      <nas:family xsi:type="xsd:string">device family</nas:family>

      <nas:parameters xsi:type="xsd:string">script parameters</nas:parameters>

      <nas:scripttype xsi:type="xsd:string">script type</nas:scripttype>

    </nas:add_advanced_script>

  </SOAP-ENV:Body>

</SOAP-ENV:Envelope>


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


<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:add_authentication xmlns:nas="http://opsware.com/nas/">

      <nas:sessionid xsi:type="xsd:string">session id from login</nas:sessionid>

      <nas:loc xsi:type="xsd:string">(device|group|db)</nas:loc>

      <!-- Optional arguments -->

      <nas:accessvariables xsi:type="xsd:string">access variables</nas:accessvariables>

      <nas:appendsnmpro xsi:type="xsd:string">append to read only community strings?</nas:appendsnmpro>

      <nas:appendsnmprw xsi:type="xsd:string">append to read write community strings?</nas:appendsnmprw>

      <nas:connectionmethods xsi:type="xsd:string">connection methods</nas:connectionmethods>

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

      <nas:enableuser xsi:type="xsd:string">enable mode username</nas:enableuser>

      <nas:group xsi:type="xsd:string">name of device group</nas:group>

      <nas:ip xsi:type="xsd:string">ipaddress</nas:ip>

      <!-- Note: host or fqdn can be sent instead of ip -->

      <nas:iprangeend xsi:type="xsd:string">ip end range</nas:iprangeend>

      <nas:iprangestart xsi:type="xsd:string">ip start range</nas:iprangestart>

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

      <nas:rule xsi:type="xsd:string">name of device password rule</nas:rule>

      <nas:ruledevicegroup xsi:type="xsd:string">device group</nas:ruledevicegroup>

      <nas:rulehostname xsi:type="xsd:string">Host name></nas:rulehostname>

      <nas:snmpro xsi:type="xsd:string">read-only community string</nas:snmpro>

      <nas:snmprw xsi:type="xsd:string">read-write community string</nas:snmprw>

      <nas:snmpv3authpw xsi:type="xsd:string">SNMPv3 authentication password</nas:snmpv3authpw>

      <nas:snmpv3encryptpw xsi:type="xsd:string">SNMPv3 encryption password</nas:snmpv3encryptpw>

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

      <nas:start xsi:type="xsd:string">YYYY:MM:DD:HH:mm</nas:start>

      <nas:sync xsi:type="xsd:string">execute synchronously?</nas:sync>

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

    </nas:add_authentication>

  </SOAP-ENV:Body>

</SOAP-ENV:Envelope>


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


<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:add_command_script xmlns:nas="http://opsware.com/nas/">

      <nas:sessionid xsi:type="xsd:string">session id from login</nas:sessionid>

      <nas:mode xsi:type="xsd:string">custom action mode</nas:mode>

      <nas:name xsi:type="xsd:string">name</nas:name>

      <nas:script xsi:type="xsd:string">script</nas:script>

      <nas:type xsi:type="xsd:string">command</nas:type>

      <!-- Optional arguments -->

      <nas:description xsi:type="xsd:string">description</nas:description>

      <nas:driver xsi:type="xsd:string">driver</nas:driver>

      <nas:scripttype xsi:type="xsd:string">script type</nas:scripttype>

    </nas:add_command_script>

  </SOAP-ENV:Body>

</SOAP-ENV:Envelope>


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


<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:add_device xmlns:nas="http://opsware.com/nas/">

      <nas:sessionid xsi:type="xsd:string">session id from login</nas:sessionid>

      <!-- Optional arguments -->

      <nas:accessmethods xsi:type="xsd:string">supported access methods</nas:accessmethods>

      <nas:asset xsi:type="xsd:string">Asset Tag</nas:asset>

      <nas:comment xsi:type="xsd:string">Comment</nas:comment>

      <nas:consoleip xsi:type="xsd:string">Console IP Address</nas:consoleip>

      <nas:consoleport xsi:type="xsd:string">Console Port</nas:consoleport>

      <nas:description xsi:type="xsd:string">Device Name</nas:description>

      <nas:domain xsi:type="xsd:string">primary FQDN</nas:domain>

      <nas:hierarchylayer xsi:type="xsd:string">hierarchy layer</nas:hierarchylayer>

      <nas:hostname xsi:type="xsd:string">Hostname</nas:hostname>

      <nas:ip xsi:type="xsd:string">ipaddress</nas:ip>

      <!-- Note: host or fqdn can be sent instead of ip -->

      <nas:location xsi:type="xsd:string">Location</nas:location>

      <nas:model xsi:type="xsd:string">Device Model</nas:model>

      <nas:natip xsi:type="xsd:string">NAT IP Address</nas:natip>

      <nas:nopoll xsi:type="xsd:string">0</nas:nopoll>

      <nas:serial xsi:type="xsd:string">Serial Number</nas:serial>

      <nas:tftpserverip xsi:type="xsd:string">TFTP Server IP Address</nas:tftpserverip>

      <nas:unmanaged xsi:type="xsd:string">0</nas:unmanaged>

      <nas:useconsoleserver xsi:type="xsd:string">true=use console server</nas:useconsoleserver>

      <nas:vendor xsi:type="xsd:string">Vendor</nas:vendor>

    </nas:add_device>

  </SOAP-ENV:Body>

</SOAP-ENV:Envelope>


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


<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:add_device_to_group xmlns:nas="http://opsware.com/nas/">

      <nas:sessionid xsi:type="xsd:string">session id from login</nas:sessionid>

      <nas:group xsi:type="xsd:string">group name</nas:group>

      <nas:ip xsi:type="xsd:string">ipaddress</nas:ip>

      <!-- Note: host or fqdn can be sent instead of ip -->

    </nas:add_device_to_group>

  </SOAP-ENV:Body>

</SOAP-ENV:Envelope>


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


<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:add_diagnostic xmlns:nas="http://opsware.com/nas/">

      <nas:sessionid xsi:type="xsd:string">session id from login</nas:sessionid>

      <nas:mode xsi:type="xsd:string">custom action mode</nas:mode>

      <nas:name xsi:type="xsd:string">name</nas:name>

      <nas:script xsi:type="xsd:string">script</nas:script>

      <nas:type xsi:type="xsd:string">diagnostic</nas:type>

      <!-- Optional arguments -->

      <nas:description xsi:type="xsd:string">description</nas:description>

      <nas:driver xsi:type="xsd:string">driver</nas:driver>

    </nas:add_diagnostic>

  </SOAP-ENV:Body>

</SOAP-ENV:Envelope>


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


<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:add_event xmlns:nas="http://opsware.com/nas/">

      <nas:sessionid xsi:type="xsd:string">session id from login</nas:sessionid>

      <nas:message xsi:type="xsd:string">message</nas:message>

      <!-- Optional arguments -->

      <nas:ip xsi:type="xsd:string">ipaddress</nas:ip>

      <!-- Note: host or fqdn can be sent instead of ip -->

    </nas:add_event>

  </SOAP-ENV:Body>

</SOAP-ENV:Envelope>


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


<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:add_event_rule xmlns:nas="http://opsware.com/nas/">

      <nas:sessionid xsi:type="xsd:string">session id from login</nas:sessionid>

      <nas:action xsi:type="xsd:string">action type</nas:action>

      <nas:name xsi:type="xsd:string">rule name</nas:name>

      <!-- Optional arguments -->

      <nas:community xsi:type="xsd:string">community string</nas:community>

      <nas:events xsi:type="xsd:string">event types</nas:events>

      <nas:receiverhost xsi:type="xsd:string">receiver host name</nas:receiverhost>

      <nas:receiverport xsi:type="xsd:string">receiver port</nas:receiverport>

    </nas:add_event_rule>

  </SOAP-ENV:Body>

</SOAP-ENV:Envelope>


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


<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:add_group xmlns:nas="http://opsware.com/nas/">

      <nas:sessionid xsi:type="xsd:string">session id from login</nas:sessionid>

      <nas:name xsi:type="xsd:string">group name</nas:name>

      <nas:type xsi:type="xsd:string">group type</nas:type>

      <!-- Optional arguments -->

      <nas:comment xsi:type="xsd:string">comment</nas:comment>

      <nas:shared xsi:type="xsd:string">0</nas:shared>

    </nas:add_group>

  </SOAP-ENV:Body>

</SOAP-ENV:Envelope>


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


<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:add_group_to_parent_group xmlns:nas="http://opsware.com/nas/">

      <nas:sessionid xsi:type="xsd:string">session id from login</nas:sessionid>

      <nas:child xsi:type="xsd:string">child group name</nas:child>

      <nas:parent xsi:type="xsd:string">parent group name</nas:parent>

    </nas:add_group_to_parent_group>

  </SOAP-ENV:Body>

</SOAP-ENV:Envelope>


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


<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:add_image xmlns:nas="http://opsware.com/nas/">

      <nas:sessionid xsi:type="xsd:string">session id from login</nas:sessionid>

      <nas:images xsi:type="xsd:string">name</nas:images>

      <nas:imageset xsi:type="xsd:string">setname</nas:imageset>

      <!-- Optional arguments -->

      <nas:bootrom xsi:type="xsd:string">bootrom</nas:bootrom>

      <nas:driver xsi:type="xsd:string">driver</nas:driver>

      <nas:memory xsi:type="xsd:string">0</nas:memory>

      <nas:model xsi:type="xsd:string">model</nas:model>

      <nas:processor xsi:type="xsd:string">processors</nas:processor>

    </nas:add_image>

  </SOAP-ENV:Body>

</SOAP-ENV:Envelope>


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


<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:add_imageoption xmlns:nas="http://opsware.com/nas/">

      <nas:sessionid xsi:type="xsd:string">session id from login</nas:sessionid>

      <!-- Optional arguments -->

      <nas:imagebootroms xsi:type="xsd:string">bootromname</nas:imagebootroms>

      <nas:imagemodels xsi:type="xsd:string">modelname</nas:imagemodels>

      <nas:imageprocessors xsi:type="xsd:string">processorname</nas:imageprocessors>

    </nas:add_imageoption>

  </SOAP-ENV:Body>

</SOAP-ENV:Envelope>


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


<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:add_ip xmlns:nas="http://opsware.com/nas/">

      <nas:sessionid xsi:type="xsd:string">session id from login</nas:sessionid>

      <nas:deviceip xsi:type="xsd:string">device ip address</nas:deviceip>

      <nas:ipvalue xsi:type="xsd:string">ip address value</nas:ipvalue>

      <!-- Optional arguments -->

      <nas:comment xsi:type="xsd:string">Comment</nas:comment>

      <nas:usetoaccess xsi:type="xsd:string">0</nas:usetoaccess>

    </nas:add_ip>

  </SOAP-ENV:Body>

</SOAP-ENV:Envelope>


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


<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:add_metadata xmlns:nas="http://opsware.com/nas/">

      <nas:sessionid xsi:type="xsd:string">session id from login</nas:sessionid>

      <nas:associatedtableid xsi:type="xsd:string">0</nas:associatedtableid>

      <nas:fieldid xsi:type="xsd:string">0</nas:fieldid>

      <!-- Optional arguments -->

      <nas:data xsi:type="xsd:string">data</nas:data>

    </nas:add_metadata>

  </SOAP-ENV:Body>

</SOAP-ENV:Envelope>


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


<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:add_metadata_field xmlns:nas="http://opsware.com/nas/">

      <nas:sessionid xsi:type="xsd:string">session id from login</nas:sessionid>

      <nas:associatedtable xsi:type="xsd:string">associated table</nas:associatedtable>

      <nas:fieldname xsi:type="xsd:string">field name</nas:fieldname>

      <!-- Optional arguments -->

      <nas:fieldvalues xsi:type="xsd:string">field values</nas:fieldvalues>

      <nas:flags xsi:type="xsd:string">0</nas:flags>

      <nas:inuse xsi:type="xsd:string">0</nas:inuse>

    </nas:add_metadata_field>

  </SOAP-ENV:Body>

</SOAP-ENV:Envelope>


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


<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:add_parent_group xmlns:nas="http://opsware.com/nas/">

      <nas:sessionid xsi:type="xsd:string">session id from login</nas:sessionid>

      <nas:name xsi:type="xsd:string">group name</nas:name>

      <nas:type xsi:type="xsd:string">group type</nas:type>

      <!-- Optional arguments -->

      <nas:comment xsi:type="xsd:string">comment</nas:comment>

    </nas:add_parent_group>

  </SOAP-ENV:Body>

</SOAP-ENV:Envelope>


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


<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:add_partition xmlns:nas="http://opsware.com/nas/">

      <nas:sessionid xsi:type="xsd:string">session id from login</nas:sessionid>

      <nas:name xsi:type="xsd:string">name</nas:name>

      <nas:viewname xsi:type="xsd:string">viewName</nas:viewname>

      <!-- Optional arguments -->

      <nas:comment xsi:type="xsd:string">comment</nas:comment>

    </nas:add_partition>

  </SOAP-ENV:Body>

</SOAP-ENV:Envelope>


add_snmp_trap_config

Description

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:add_snmp_trap_config xmlns:nas="http://opsware.com/nas/">

      <nas:sessionid xsi:type="xsd:string">session id from login</nas:sessionid>

      <nas:value xsi:type="xsd:string">value</nas:value>

    </nas:add_snmp_trap_config>

  </SOAP-ENV:Body>

</SOAP-ENV:Envelope>


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


<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:add_system_message xmlns:nas="http://opsware.com/nas/">

      <nas:sessionid xsi:type="xsd:string">session id from login</nas:sessionid>

      <nas:message xsi:type="xsd:string">message</nas:message>

      <!-- Optional arguments -->

      <nas:ip xsi:type="xsd:string">ipaddress</nas:ip>

      <!-- Note: host or fqdn can be sent instead of ip -->

    </nas:add_system_message>

  </SOAP-ENV:Body>

</SOAP-ENV:Envelope>


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


<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:add_user xmlns:nas="http://opsware.com/nas/">

      <nas:sessionid xsi:type="xsd:string">session id from login</nas:sessionid>

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

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

      <!-- Optional arguments -->

      <nas:aaapassword xsi:type="xsd:string">AAA Password</nas:aaapassword>

      <nas:aaausername xsi:type="xsd:string">AAA Username</nas:aaausername>

      <nas:email xsi:type="xsd:string">Email</nas:email>

      <nas:extauthfailover xsi:type="xsd:string">Use External Auth Failover (yes|no)</nas:extauthfailover>

      <nas:fn xsi:type="xsd:string">FirstName</nas:fn>

      <nas:ln xsi:type="xsd:string">LastName</nas:ln>

      <nas:useaaaloginforproxy xsi:type="xsd:string">Use AAA Login for Proxy (yes|no)</nas:useaaaloginforproxy>

    </nas:add_user>

  </SOAP-ENV:Body>

</SOAP-ENV:Envelope>


add_user_to_group

Add a user to a user group.

Description

  • u - Username
  • g - User group name

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:add_user_to_group xmlns:nas="http://opsware.com/nas/">

      <nas:sessionid xsi:type="xsd:string">session id from login</nas:sessionid>

      <nas:g xsi:type="xsd:string">group name</nas:g>

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

    </nas:add_user_to_group>

  </SOAP-ENV:Body>

</SOAP-ENV:Envelope>


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


<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:annotate_access xmlns:nas="http://opsware.com/nas/">

      <nas:sessionid xsi:type="xsd:string">session id from login</nas:sessionid>

      <nas:id xsi:type="xsd:string">configid</nas:id>

      <!-- Optional arguments -->

      <nas:comment xsi:type="xsd:string">comment</nas:comment>

      <nas:customname xsi:type="xsd:string">custom field name</nas:customname>

      <nas:customvalue xsi:type="xsd:string">custom value</nas:customvalue>

      <nas:name xsi:type="xsd:string">name</nas:name>

    </nas:annotate_access>

  </SOAP-ENV:Body>

</SOAP-ENV:Envelope>


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


<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:annotate_config xmlns:nas="http://opsware.com/nas/">

      <nas:sessionid xsi:type="xsd:string">session id from login</nas:sessionid>

      <nas:comment xsi:type="xsd:string">comment</nas:comment>

      <nas:id xsi:type="xsd:string">configid</nas:id>

    </nas:annotate_config>

  </SOAP-ENV:Body>

</SOAP-ENV:Envelope>


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


<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:assign_driver xmlns:nas="http://opsware.com/nas/">

      <nas:sessionid xsi:type="xsd:string">session id from login</nas:sessionid>

      <!-- Optional arguments -->

      <nas:id xsi:type="xsd:string">deviceid</nas:id>

      <nas:ip xsi:type="xsd:string">ipaddress</nas:ip>

      <!-- Note: host or fqdn can be sent instead of ip -->

      <nas:name xsi:type="xsd:string">drivername</nas:name>

    </nas:assign_driver>

  </SOAP-ENV:Body>

</SOAP-ENV:Envelope>


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


<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:configure_syslog xmlns:nas="http://opsware.com/nas/">

      <nas:sessionid xsi:type="xsd:string">session id from login</nas:sessionid>

      <!-- Optional arguments -->

      <nas:comment xsi:type="xsd:string">comment</nas:comment>

      <nas:group xsi:type="xsd:string">group</nas:group>

      <nas:ip xsi:type="xsd:string">ipaddress</nas:ip>

      <!-- Note: host or fqdn can be sent instead of ip -->

      <nas:rep xsi:type="xsd:string">repeat</nas:rep>

      <nas:start xsi:type="xsd:string">YYYY:MM:DD:HH:mm</nas:start>

      <nas:sync xsi:type="xsd:string">execute synchronously?</nas:sync>

      <nas:usesyslogrelay xsi:type="xsd:string">ipaddress</nas:usesyslogrelay>

    </nas:configure_syslog>

  </SOAP-ENV:Body>

</SOAP-ENV:Envelope>


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


<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:deactivate_device xmlns:nas="http://opsware.com/nas/">

      <nas:sessionid xsi:type="xsd:string">session id from login</nas:sessionid>

      <nas:ip xsi:type="xsd:string">ipaddress</nas:ip>

      <!-- Note: host or fqdn can be sent instead of ip -->

    </nas:deactivate_device>

  </SOAP-ENV:Body>

</SOAP-ENV:Envelope>


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


<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:del_access xmlns:nas="http://opsware.com/nas/">

      <nas:sessionid xsi:type="xsd:string">session id from login</nas:sessionid>

      <!-- Optional arguments -->

      <nas:cutoff xsi:type="xsd:string">YYYY:MM:DD:HH:mm</nas:cutoff>

      <nas:id xsi:type="xsd:string">id</nas:id>

    </nas:del_access>

  </SOAP-ENV:Body>

</SOAP-ENV:Envelope>


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


<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:del_authentication xmlns:nas="http://opsware.com/nas/">

      <nas:sessionid xsi:type="xsd:string">session id from login</nas:sessionid>

      <!-- Optional arguments -->

      <nas:ip xsi:type="xsd:string">ipaddress</nas:ip>

      <!-- Note: host or fqdn can be sent instead of ip -->

      <nas:loc xsi:type="xsd:string">(device|group|db</nas:loc>

      <nas:rulename xsi:type="xsd:string">password rule to delete</nas:rulename>

    </nas:del_authentication>

  </SOAP-ENV:Body>

</SOAP-ENV:Envelope>


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


<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:del_device xmlns:nas="http://opsware.com/nas/">

      <nas:sessionid xsi:type="xsd:string">session id from login</nas:sessionid>

      <nas:ip xsi:type="xsd:string">ipaddress</nas:ip>

      <!-- Note: host or fqdn can be sent instead of ip -->

    </nas:del_device>

  </SOAP-ENV:Body>

</SOAP-ENV:Envelope>


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


<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:del_device_data xmlns:nas="http://opsware.com/nas/">

      <nas:sessionid xsi:type="xsd:string">session id from login</nas:sessionid>

      <!-- Optional arguments -->

      <nas:cutoff xsi:type="xsd:string">YYYY:MM:DD:HH:mm</nas:cutoff>

      <nas:id xsi:type="xsd:string">id</nas:id>

    </nas:del_device_data>

  </SOAP-ENV:Body>

</SOAP-ENV:Envelope>


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


<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:del_device_from_group xmlns:nas="http://opsware.com/nas/">

      <nas:sessionid xsi:type="xsd:string">session id from login</nas:sessionid>

      <nas:group xsi:type="xsd:string">group name</nas:group>

      <nas:ip xsi:type="xsd:string">ipaddress</nas:ip>

      <!-- Note: host or fqdn can be sent instead of ip -->

    </nas:del_device_from_group>

  </SOAP-ENV:Body>

</SOAP-ENV:Envelope>


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


<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:del_drivers xmlns:nas="http://opsware.com/nas/">

      <nas:sessionid xsi:type="xsd:string">session id from login</nas:sessionid>

      <nas:ip xsi:type="xsd:string">ipaddress</nas:ip>

      <!-- Note: host or fqdn can be sent instead of ip -->

    </nas:del_drivers>

  </SOAP-ENV:Body>

</SOAP-ENV:Envelope>


del_event

Delete the specified event.

Description

  • id - A valid event id

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:del_event xmlns:nas="http://opsware.com/nas/">

      <nas:sessionid xsi:type="xsd:string">session id from login</nas:sessionid>

      <nas:id xsi:type="xsd:string">id</nas:id>

    </nas:del_event>

  </SOAP-ENV:Body>

</SOAP-ENV:Envelope>


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


<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:del_group xmlns:nas="http://opsware.com/nas/">

      <nas:sessionid xsi:type="xsd:string">session id from login</nas:sessionid>

      <nas:name xsi:type="xsd:string">group name</nas:name>

      <nas:type xsi:type="xsd:string">group type</nas:type>

    </nas:del_group>

  </SOAP-ENV:Body>

</SOAP-ENV:Envelope>


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


<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:del_group_from_parent_group xmlns:nas="http://opsware.com/nas/">

      <nas:sessionid xsi:type="xsd:string">session id from login</nas:sessionid>

      <nas:child xsi:type="xsd:string">child group name</nas:child>

      <nas:parent xsi:type="xsd:string">parent group name</nas:parent>

    </nas:del_group_from_parent_group>

  </SOAP-ENV:Body>

</SOAP-ENV:Envelope>


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


<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:del_ip xmlns:nas="http://opsware.com/nas/">

      <nas:sessionid xsi:type="xsd:string">session id from login</nas:sessionid>

      <nas:deviceip xsi:type="xsd:string">device ip address</nas:deviceip>

      <nas:ipvalue xsi:type="xsd:string">ip address value</nas:ipvalue>

    </nas:del_ip>

  </SOAP-ENV:Body>

</SOAP-ENV:Envelope>


del_metadata

Delete a specific piece of custom data.

Description

  • metadataid - ID of the custom data to delete

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:del_metadata xmlns:nas="http://opsware.com/nas/">

      <nas:sessionid xsi:type="xsd:string">session id from login</nas:sessionid>

      <nas:metadataid xsi:type="xsd:string">0</nas:metadataid>

    </nas:del_metadata>

  </SOAP-ENV:Body>

</SOAP-ENV:Envelope>


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


<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:del_metadata_field xmlns:nas="http://opsware.com/nas/">

      <nas:sessionid xsi:type="xsd:string">session id from login</nas:sessionid>

      <nas:fieldid xsi:type="xsd:string">0</nas:fieldid>

    </nas:del_metadata_field>

  </SOAP-ENV:Body>

</SOAP-ENV:Envelope>


del_partition

Delete a partition from view.

Description

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

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:del_partition xmlns:nas="http://opsware.com/nas/">

      <nas:sessionid xsi:type="xsd:string">session id from login</nas:sessionid>

      <nas:name xsi:type="xsd:string">partition name</nas:name>

    </nas:del_partition>

  </SOAP-ENV:Body>

</SOAP-ENV:Envelope>


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


<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:del_script xmlns:nas="http://opsware.com/nas/">

      <nas:sessionid xsi:type="xsd:string">session id from login</nas:sessionid>

      <!-- Optional arguments -->

      <nas:id xsi:type="xsd:string">id</nas:id>

      <nas:name xsi:type="xsd:string">name</nas:name>

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

    </nas:del_script>

  </SOAP-ENV:Body>

</SOAP-ENV:Envelope>


del_session

Delete an interceptor log record.

Description

  • id - Interceptor log ID

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:del_session xmlns:nas="http://opsware.com/nas/">

      <nas:sessionid xsi:type="xsd:string">session id from login</nas:sessionid>

      <nas:id xsi:type="xsd:string">id</nas:id>

    </nas:del_session>

  </SOAP-ENV:Body>

</SOAP-ENV:Envelope>


del_system_message

Delete the specified system message.

Description

  • id - A valid system message id

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:del_system_message xmlns:nas="http://opsware.com/nas/">

      <nas:sessionid xsi:type="xsd:string">session id from login</nas:sessionid>

      <nas:id xsi:type="xsd:string">id</nas:id>

    </nas:del_system_message>

  </SOAP-ENV:Body>

</SOAP-ENV:Envelope>


del_task

Delete a task.

Description

Deletes a task, whether it has run or not.

  • id - A task ID

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:del_task xmlns:nas="http://opsware.com/nas/">

      <nas:sessionid xsi:type="xsd:string">session id from login</nas:sessionid>

      <nas:id xsi:type="xsd:string">taskid</nas:id>

    </nas:del_task>

  </SOAP-ENV:Body>

</SOAP-ENV:Envelope>


del_user

Delete a user from the system.

Description

  • u - The user name to be deleted

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:del_user xmlns:nas="http://opsware.com/nas/">

      <nas:sessionid xsi:type="xsd:string">session id from login</nas:sessionid>

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

    </nas:del_user>

  </SOAP-ENV:Body>

</SOAP-ENV:Envelope>


del_user_from_group

Delete a user from a user group.

Description

  • u - Username
  • g - User group name

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:del_user_from_group xmlns:nas="http://opsware.com/nas/">

      <nas:sessionid xsi:type="xsd:string">session id from login</nas:sessionid>

      <nas:g xsi:type="xsd:string">group name</nas:g>

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

    </nas:del_user_from_group>

  </SOAP-ENV:Body>

</SOAP-ENV:Envelope>


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


<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:delete_image xmlns:nas="http://opsware.com/nas/">

      <nas:sessionid xsi:type="xsd:string">session id from login</nas:sessionid>

      <nas:images xsi:type="xsd:string">name</nas:images>

      <nas:imageset xsi:type="xsd:string">setname</nas:imageset>

    </nas:delete_image>

  </SOAP-ENV:Body>

</SOAP-ENV:Envelope>


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


<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:deploy_config xmlns:nas="http://opsware.com/nas/">

      <nas:sessionid xsi:type="xsd:string">session id from login</nas:sessionid>

      <nas:ip xsi:type="xsd:string">ipaddress</nas:ip>

      <!-- Note: host or fqdn can be sent instead of ip -->

      <nas:option xsi:type="xsd:string">(current|startup_reload)</nas:option>

      <!-- Optional arguments -->

      <nas:configtext xsi:type="xsd:string">configuration text to deploy</nas:configtext>

      <nas:id xsi:type="xsd:string">configid</nas:id>

      <nas:start xsi:type="xsd:string">YYYY:MM:DD:HH:mm</nas:start>

      <nas:sync xsi:type="xsd:string">execute synchronously?</nas:sync>

    </nas:deploy_config>

  </SOAP-ENV:Body>

</SOAP-ENV:Envelope>


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


<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:deploy_image xmlns:nas="http://opsware.com/nas/">

      <nas:sessionid xsi:type="xsd:string">session id from login</nas:sessionid>

      <nas:images xsi:type="xsd:string">name</nas:images>

      <nas:imageset xsi:type="xsd:string">setname</nas:imageset>

      <nas:ip xsi:type="xsd:string">ip</nas:ip>

      <!-- Note: host or fqdn can be sent instead of ip -->

      <!-- Optional arguments -->

      <nas:filesystem xsi:type="xsd:string">fs</nas:filesystem>

      <nas:posttask xsi:type="xsd:string">posttask</nas:posttask>

      <nas:pretask xsi:type="xsd:string">pretask</nas:pretask>

      <nas:reboot xsi:type="xsd:string">reboot</nas:reboot>

      <nas:rebootwait xsi:type="xsd:string">0</nas:rebootwait>

      <nas:sessionlog xsi:type="xsd:string">(true|false)</nas:sessionlog>

      <nas:verify xsi:type="xsd:string">verify</nas:verify>

    </nas:deploy_image>

  </SOAP-ENV:Body>

</SOAP-ENV:Envelope>


diff_config

Show the differences between two configs.

Description

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

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:diff_config xmlns:nas="http://opsware.com/nas/">

      <nas:sessionid xsi:type="xsd:string">session id from login</nas:sessionid>

      <nas:id1 xsi:type="xsd:string">configid1</nas:id1>

      <nas:id2 xsi:type="xsd:string">configid2</nas:id2>

    </nas:diff_config>

  </SOAP-ENV:Body>

</SOAP-ENV:Envelope>


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


<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:disable_device xmlns:nas="http://opsware.com/nas/">

      <nas:sessionid xsi:type="xsd:string">session id from login</nas:sessionid>

      <nas:ip xsi:type="xsd:string">ipaddress</nas:ip>

      <!-- Note: host or fqdn can be sent instead of ip -->

    </nas:disable_device>

  </SOAP-ENV:Body>

</SOAP-ENV:Envelope>


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


<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:discover_driver xmlns:nas="http://opsware.com/nas/">

      <nas:sessionid xsi:type="xsd:string">session id from login</nas:sessionid>

      <nas:ip xsi:type="xsd:string">ipaddress</nas:ip>

      <!-- Note: host or fqdn can be sent instead of ip -->

    </nas:discover_driver>

  </SOAP-ENV:Body>

</SOAP-ENV:Envelope>


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


<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:discover_drivers xmlns:nas="http://opsware.com/nas/">

      <nas:sessionid xsi:type="xsd:string">session id from login</nas:sessionid>

      <!-- Optional arguments -->

      <nas:group xsi:type="xsd:string">group</nas:group>

      <nas:noskip xsi:type="xsd:string">dont skip if driver already assigned</nas:noskip>

    </nas:discover_drivers>

  </SOAP-ENV:Body>

</SOAP-ENV:Envelope>


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


<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:enable_device xmlns:nas="http://opsware.com/nas/">

      <nas:sessionid xsi:type="xsd:string">session id from login</nas:sessionid>

      <nas:ip xsi:type="xsd:string">ipaddress</nas:ip>

      <!-- Note: host or fqdn can be sent instead of ip -->

    </nas:enable_device>

  </SOAP-ENV:Body>

</SOAP-ENV:Envelope>


generate_stacktrace

Description

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:generate_stacktrace xmlns:nas="http://opsware.com/nas/">

      <nas:sessionid xsi:type="xsd:string">session id from login</nas:sessionid>

    </nas:generate_stacktrace>

  </SOAP-ENV:Body>

</SOAP-ENV:Envelope>


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


<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:get_snapshot xmlns:nas="http://opsware.com/nas/">

      <nas:sessionid xsi:type="xsd:string">session id from login</nas:sessionid>

      <!-- Optional arguments -->

      <nas:comment xsi:type="xsd:string">comment</nas:comment>

      <nas:duration xsi:type="xsd:string">duration</nas:duration>

      <nas:group xsi:type="xsd:string">group</nas:group>

      <nas:ip xsi:type="xsd:string">ipaddress</nas:ip>

      <!-- Note: host or fqdn can be sent instead of ip -->

      <nas:rep xsi:type="xsd:string">repeat</nas:rep>

      <nas:start xsi:type="xsd:string">YYYY:MM:DD:HH:mm</nas:start>

      <nas:sync xsi:type="xsd:string">execute synchronously?</nas:sync>

    </nas:get_snapshot>

  </SOAP-ENV:Body>

</SOAP-ENV:Envelope>


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


<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:import xmlns:nas="http://opsware.com/nas/">

      <nas:sessionid xsi:type="xsd:string">session id from login</nas:sessionid>

      <!-- Optional arguments -->

      <nas:append xsi:type="xsd:string">(true|false)</nas:append>

      <nas:auth xsi:type="xsd:string">auth</nas:auth>

      <nas:cleanafter xsi:type="xsd:string">(true|false)</nas:cleanafter>

      <nas:configuresyslog xsi:type="xsd:string">(true|false)</nas:configuresyslog>

      <nas:data xsi:type="xsd:string">data</nas:data>

      <nas:debug xsi:type="xsd:string">(true|false)</nas:debug>

      <nas:device xsi:type="xsd:string">device</nas:device>

      <nas:deviceorigin xsi:type="xsd:string">deviceorigin</nas:deviceorigin>

      <nas:discoverafter xsi:type="xsd:string">(true|false)</nas:discoverafter>

      <nas:filter xsi:type="xsd:string">filter</nas:filter>

      <nas:input xsi:type="xsd:string">input</nas:input>

      <nas:log xsi:type="xsd:string">log</nas:log>

      <nas:usesyslogrelay xsi:type="xsd:string">usesyslogrelay</nas:usesyslogrelay>

    </nas:import>

  </SOAP-ENV:Body>

</SOAP-ENV:Envelope>


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: "
  • 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


<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:list_access xmlns:nas="http://opsware.com/nas/">

      <nas:sessionid xsi:type="xsd:string">session id from login</nas:sessionid>

      <nas:ip xsi:type="xsd:string">ipaddress</nas:ip>

      <!-- Note: host or fqdn can be sent instead of ip -->

      <!-- Optional arguments -->

      <nas:end xsi:type="xsd:string">endDate</nas:end>

      <nas:start xsi:type="xsd:string">startDate</nas:start>

    </nas:list_access>

  </SOAP-ENV:Body>

</SOAP-ENV:Envelope>


list_access_all

List all access records for all devices.

Description

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:list_access_all xmlns:nas="http://opsware.com/nas/">

      <nas:sessionid xsi:type="xsd:string">session id from login</nas:sessionid>

    </nas:list_access_all>

  </SOAP-ENV:Body>

</SOAP-ENV:Envelope>


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


<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:list_acl xmlns:nas="http://opsware.com/nas/">

      <nas:sessionid xsi:type="xsd:string">session id from login</nas:sessionid>

      <!-- Optional arguments -->

      <nas:aclid xsi:type="xsd:string">device acl id</nas:aclid>

      <nas:deviceid xsi:type="xsd:string">0</nas:deviceid>

      <nas:fqdn xsi:type="xsd:string">primary fqdn</nas:fqdn>

      <nas:handle xsi:type="xsd:string">handle</nas:handle>

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

      <nas:includeapplication xsi:type="xsd:string">include application</nas:includeapplication>

      <nas:includescript xsi:type="xsd:string">include script</nas:includescript>

      <nas:ip xsi:type="xsd:string">ipaddress</nas:ip>

      <!-- Note: host or fqdn can be sent instead of ip -->

      <nas:recent xsi:type="xsd:string">(true|false)</nas:recent>

    </nas:list_acl>

  </SOAP-ENV:Body>

</SOAP-ENV:Envelope>


list_agvalues

Description

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:list_agvalues xmlns:nas="http://opsware.com/nas/">

      <nas:sessionid xsi:type="xsd:string">session id from login</nas:sessionid>

      <nas:agtypes xsi:type="xsd:string">agtypes</nas:agtypes>

      <nas:deviceids xsi:type="xsd:string">deviceids</nas:deviceids>

    </nas:list_agvalues>

  </SOAP-ENV:Body>

</SOAP-ENV:Envelope>


list_all_drivers

List all drivers installed in the system.

Description

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:list_all_drivers xmlns:nas="http://opsware.com/nas/">

      <nas:sessionid xsi:type="xsd:string">session id from login</nas:sessionid>

    </nas:list_all_drivers>

  </SOAP-ENV:Body>

</SOAP-ENV:Envelope>


list_authentication

list Authentication.

Description

Displays the Authentication Rules by Rule Name.

  • rulename - List Authentication by rule name

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:list_authentication xmlns:nas="http://opsware.com/nas/">

      <nas:sessionid xsi:type="xsd:string">session id from login</nas:sessionid>

      <!-- Optional arguments -->

      <nas:rulename xsi:type="xsd:string">Rule Name</nas:rulename>

    </nas:list_authentication>

  </SOAP-ENV:Body>

</SOAP-ENV:Envelope>


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:
  • 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


<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:list_basicip xmlns:nas="http://opsware.com/nas/">

      <nas:sessionid xsi:type="xsd:string">session id from login</nas:sessionid>

      <nas:ip xsi:type="xsd:string">ipaddress</nas:ip>

      <!-- Note: host or fqdn can be sent instead of ip -->

      <!-- Optional arguments -->

      <nas:end xsi:type="xsd:string">endDate</nas:end>

      <nas:start xsi:type="xsd:string">startDate</nas:start>

    </nas:list_basicip>

  </SOAP-ENV:Body>

</SOAP-ENV:Envelope>


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:
  • 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


<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:list_config xmlns:nas="http://opsware.com/nas/">

      <nas:sessionid xsi:type="xsd:string">session id from login</nas:sessionid>

      <!-- Optional arguments -->

      <nas:end xsi:type="xsd:string">endDate</nas:end>

      <nas:ids xsi:type="xsd:string">id list</nas:ids>

      <nas:ip xsi:type="xsd:string">ipaddress</nas:ip>

      <!-- Note: host or fqdn can be sent instead of ip -->

      <nas:mask xsi:type="xsd:string">included size is for masked config</nas:mask>

      <nas:size xsi:type="xsd:string">include size</nas:size>

      <nas:start xsi:type="xsd:string">startDate</nas:start>

    </nas:list_config>

  </SOAP-ENV:Body>

</SOAP-ENV:Envelope>


list_config_all

List all configs for all devices.

Description

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:list_config_all xmlns:nas="http://opsware.com/nas/">

      <nas:sessionid xsi:type="xsd:string">session id from login</nas:sessionid>

    </nas:list_config_all>

  </SOAP-ENV:Body>

</SOAP-ENV:Envelope>


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:
  • 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


<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:list_config_id xmlns:nas="http://opsware.com/nas/">

      <nas:sessionid xsi:type="xsd:string">session id from login</nas:sessionid>

      <!-- Optional arguments -->

      <nas:end xsi:type="xsd:string">endDate</nas:end>

      <nas:id xsi:type="xsd:string">id</nas:id>

      <nas:ip xsi:type="xsd:string">ipaddress</nas:ip>

      <!-- Note: host or fqdn can be sent instead of ip -->

      <nas:start xsi:type="xsd:string">startDate</nas:start>

    </nas:list_config_id>

  </SOAP-ENV:Body>

</SOAP-ENV:Envelope>


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


<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:list_custom_data_definition xmlns:nas="http://opsware.com/nas/">

      <nas:sessionid xsi:type="xsd:string">session id from login</nas:sessionid>

      <nas:tablename xsi:type="xsd:string">Table Name</nas:tablename>

    </nas:list_custom_data_definition>

  </SOAP-ENV:Body>

</SOAP-ENV:Envelope>


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


<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:list_device xmlns:nas="http://opsware.com/nas/">

      <nas:sessionid xsi:type="xsd:string">session id from login</nas:sessionid>

      <!-- Optional arguments -->

      <nas:disabled xsi:type="xsd:string">list disabled devices</nas:disabled>

      <nas:family xsi:type="xsd:string">Device Family</nas:family>

      <nas:group xsi:type="xsd:string">device group</nas:group>

      <nas:hierarchy xsi:type="xsd:string">0</nas:hierarchy>

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

      <nas:ids xsi:type="xsd:string">id list</nas:ids>

      <nas:ip xsi:type="xsd:string">ipaddress</nas:ip>

      <!-- Note: host or fqdn can be sent instead of ip -->

      <nas:limitcount xsi:type="xsd:string">0</nas:limitcount>

      <nas:model xsi:type="xsd:string">Device Model</nas:model>

      <nas:partition xsi:type="xsd:string">partition name</nas:partition>

      <nas:pollexcluded xsi:type="xsd:string">list devices with polling turned off</nas:pollexcluded>

      <nas:realm xsi:type="xsd:string">realm name</nas:realm>

      <nas:software xsi:type="xsd:string">Software</nas:software>

      <nas:startid xsi:type="xsd:string">0</nas:startid>

      <nas:type xsi:type="xsd:string">Device Type</nas:type>

      <nas:vendor xsi:type="xsd:string">Device Vendor</nas:vendor>

    </nas:list_device>

  </SOAP-ENV:Body>

</SOAP-ENV:Envelope>


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


<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:list_device_data xmlns:nas="http://opsware.com/nas/">

      <nas:sessionid xsi:type="xsd:string">session id from login</nas:sessionid>

      <nas:ip xsi:type="xsd:string">ipaddress</nas:ip>

      <!-- Note: host or fqdn can be sent instead of ip -->

      <!-- Optional arguments -->

      <nas:datatype xsi:type="xsd:string">Data Type</nas:datatype>

    </nas:list_device_data>

  </SOAP-ENV:Body>

</SOAP-ENV:Envelope>


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


<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:list_device_family xmlns:nas="http://opsware.com/nas/">

      <nas:sessionid xsi:type="xsd:string">session id from login</nas:sessionid>

      <!-- Optional arguments -->

      <nas:group xsi:type="xsd:string">Device Group</nas:group>

      <nas:model xsi:type="xsd:string">Device Model</nas:model>

      <nas:software xsi:type="xsd:string">Software</nas:software>

      <nas:type xsi:type="xsd:string">Device Type</nas:type>

      <nas:vendor xsi:type="xsd:string">Vendor</nas:vendor>

    </nas:list_device_family>

  </SOAP-ENV:Body>

</SOAP-ENV:Envelope>


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


<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:list_device_group xmlns:nas="http://opsware.com/nas/">

      <nas:sessionid xsi:type="xsd:string">session id from login</nas:sessionid>

      <!-- Optional arguments -->

      <nas:family xsi:type="xsd:string">Device Family</nas:family>

      <nas:model xsi:type="xsd:string">Device Model</nas:model>

      <nas:parent xsi:type="xsd:string">Parent Device Group</nas:parent>

      <nas:software xsi:type="xsd:string">Software</nas:software>

      <nas:type xsi:type="xsd:string">Device Type</nas:type>

      <nas:vendor xsi:type="xsd:string">Vendor</nas:vendor>

    </nas:list_device_group>

  </SOAP-ENV:Body>

</SOAP-ENV:Envelope>


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


<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:list_device_id xmlns:nas="http://opsware.com/nas/">

      <nas:sessionid xsi:type="xsd:string">session id from login</nas:sessionid>

      <!-- Optional arguments -->

      <nas:disabled xsi:type="xsd:string">list disabled devices</nas:disabled>

      <nas:family xsi:type="xsd:string">Device Family</nas:family>

      <nas:group xsi:type="xsd:string">device group</nas:group>

      <nas:hierarchy xsi:type="xsd:string">0</nas:hierarchy>

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

      <nas:id xsi:type="xsd:string">Device ID</nas:id>

      <nas:ip xsi:type="xsd:string">ipaddress</nas:ip>

      <!-- Note: host or fqdn can be sent instead of ip -->

      <nas:model xsi:type="xsd:string">Device Model</nas:model>

      <nas:pollexcluded xsi:type="xsd:string">list devices with polling turned off</nas:pollexcluded>

      <nas:realm xsi:type="xsd:string">realm name</nas:realm>

      <nas:software xsi:type="xsd:string">Software</nas:software>

      <nas:type xsi:type="xsd:string">Device Type</nas:type>

      <nas:vendor xsi:type="xsd:string">Device Vendor</nas:vendor>

      <nas:viewable_by xsi:type="xsd:string">0</nas:viewable_by>

    </nas:list_device_id>

  </SOAP-ENV:Body>

</SOAP-ENV:Envelope>


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


<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:list_device_model xmlns:nas="http://opsware.com/nas/">

      <nas:sessionid xsi:type="xsd:string">session id from login</nas:sessionid>

      <!-- Optional arguments -->

      <nas:family xsi:type="xsd:string">Device Family</nas:family>

      <nas:group xsi:type="xsd:string">Device Group</nas:group>

      <nas:software xsi:type="xsd:string">Software</nas:software>

      <nas:type xsi:type="xsd:string">Device Type</nas:type>

      <nas:vendor xsi:type="xsd:string">Vendor</nas:vendor>

    </nas:list_device_model>

  </SOAP-ENV:Body>

</SOAP-ENV:Envelope>


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


<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:list_device_software xmlns:nas="http://opsware.com/nas/">

      <nas:sessionid xsi:type="xsd:string">session id from login</nas:sessionid>

      <!-- Optional arguments -->

      <nas:family xsi:type="xsd:string">Device Family</nas:family>

      <nas:group xsi:type="xsd:string">Device Group</nas:group>

      <nas:model xsi:type="xsd:string">Device Model</nas:model>

      <nas:type xsi:type="xsd:string">Device Type</nas:type>

      <nas:vendor xsi:type="xsd:string">Vendor</nas:vendor>

    </nas:list_device_software>

  </SOAP-ENV:Body>

</SOAP-ENV:Envelope>


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


<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:list_device_type xmlns:nas="http://opsware.com/nas/">

      <nas:sessionid xsi:type="xsd:string">session id from login</nas:sessionid>

      <!-- Optional arguments -->

      <nas:family xsi:type="xsd:string">Device Family</nas:family>

      <nas:group xsi:type="xsd:string">Device Group</nas:group>

      <nas:model xsi:type="xsd:string">Device Model</nas:model>

      <nas:software xsi:type="xsd:string">Software</nas:software>

      <nas:vendor xsi:type="xsd:string">Vendor</nas:vendor>

    </nas:list_device_type>

  </SOAP-ENV:Body>

</SOAP-ENV:Envelope>


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


<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:list_device_vendor xmlns:nas="http://opsware.com/nas/">

      <nas:sessionid xsi:type="xsd:string">session id from login</nas:sessionid>

      <!-- Optional arguments -->

      <nas:family xsi:type="xsd:string">Device Family</nas:family>

      <nas:group xsi:type="xsd:string">Device Group</nas:group>

      <nas:model xsi:type="xsd:string">Device Model</nas:model>

      <nas:software xsi:type="xsd:string">Software</nas:software>

      <nas:type xsi:type="xsd:string">Device Type</nas:type>

    </nas:list_device_vendor>

  </SOAP-ENV:Body>

</SOAP-ENV:Envelope>


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


<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:list_deviceinfo xmlns:nas="http://opsware.com/nas/">

      <nas:sessionid xsi:type="xsd:string">session id from login</nas:sessionid>

      <nas:ip xsi:type="xsd:string">ipaddress</nas:ip>

      <!-- Note: host or fqdn can be sent instead of ip -->

    </nas:list_deviceinfo>

  </SOAP-ENV:Body>

</SOAP-ENV:Envelope>


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:
  • 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


<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:list_diagnostic xmlns:nas="http://opsware.com/nas/">

      <nas:sessionid xsi:type="xsd:string">session id from login</nas:sessionid>

      <nas:diagnostic xsi:type="xsd:string">custom diagnostic name</nas:diagnostic>

      <nas:ip xsi:type="xsd:string">ipaddress</nas:ip>

      <!-- Note: host or fqdn can be sent instead of ip -->

      <!-- Optional arguments -->

      <nas:end xsi:type="xsd:string">endDate</nas:end>

      <nas:start xsi:type="xsd:string">startDate</nas:start>

    </nas:list_diagnostic>

  </SOAP-ENV:Body>

</SOAP-ENV:Envelope>


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


<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:list_drivers xmlns:nas="http://opsware.com/nas/">

      <nas:sessionid xsi:type="xsd:string">session id from login</nas:sessionid>

      <nas:ip xsi:type="xsd:string">ipaddress</nas:ip>

      <!-- Note: host or fqdn can be sent instead of ip -->

    </nas:list_drivers>

  </SOAP-ENV:Body>

</SOAP-ENV:Envelope>


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:
  • end - Display only events before this date.

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:list_event xmlns:nas="http://opsware.com/nas/">

      <nas:sessionid xsi:type="xsd:string">session id from login</nas:sessionid>

      <!-- Optional arguments -->

      <nas:end xsi:type="xsd:string">endDate</nas:end>

      <nas:ip xsi:type="xsd:string">ipaddress</nas:ip>

      <!-- Note: host or fqdn can be sent instead of ip -->

      <nas:start xsi:type="xsd:string">startDate</nas:start>

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

    </nas:list_event>

  </SOAP-ENV:Body>

</SOAP-ENV:Envelope>


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


<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:list_group_id xmlns:nas="http://opsware.com/nas/">

      <nas:sessionid xsi:type="xsd:string">session id from login</nas:sessionid>

      <nas:type xsi:type="xsd:string">(device|user)</nas:type>

      <!-- Optional arguments -->

      <nas:viewable_by xsi:type="xsd:string">0</nas:viewable_by>

    </nas:list_group_id>

  </SOAP-ENV:Body>

</SOAP-ENV:Envelope>


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


<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:list_groups xmlns:nas="http://opsware.com/nas/">

      <nas:sessionid xsi:type="xsd:string">session id from login</nas:sessionid>

      <nas:type xsi:type="xsd:string">group type</nas:type>

      <!-- Optional arguments -->

      <nas:ip xsi:type="xsd:string">ipaddress</nas:ip>

      <!-- Note: host or fqdn can be sent instead of ip -->

      <nas:parent xsi:type="xsd:string">parent group</nas:parent>

    </nas:list_groups>

  </SOAP-ENV:Body>

</SOAP-ENV:Envelope>


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:
  • 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


<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:list_icmp xmlns:nas="http://opsware.com/nas/">

      <nas:sessionid xsi:type="xsd:string">session id from login</nas:sessionid>

      <nas:ip xsi:type="xsd:string">ipaddress</nas:ip>

      <!-- Note: host or fqdn can be sent instead of ip -->

      <!-- Optional arguments -->

      <nas:end xsi:type="xsd:string">endDate</nas:end>

      <nas:start xsi:type="xsd:string">startDate</nas:start>

    </nas:list_icmp>

  </SOAP-ENV:Body>

</SOAP-ENV:Envelope>


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


<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:list_image xmlns:nas="http://opsware.com/nas/">

      <nas:sessionid xsi:type="xsd:string">session id from login</nas:sessionid>

      <!-- Optional arguments -->

      <nas:imageset xsi:type="xsd:string">setname</nas:imageset>

      <nas:ip xsi:type="xsd:string">ipaddress</nas:ip>

      <!-- Note: host or fqdn can be sent instead of ip -->

    </nas:list_image>

  </SOAP-ENV:Body>

</SOAP-ENV:Envelope>


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


<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:list_imageoption xmlns:nas="http://opsware.com/nas/">

      <nas:sessionid xsi:type="xsd:string">session id from login</nas:sessionid>

      <nas:name xsi:type="xsd:string">(model|processor|bootrom)</nas:name>

    </nas:list_imageoption>

  </SOAP-ENV:Body>

</SOAP-ENV:Envelope>


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


<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:list_imageset xmlns:nas="http://opsware.com/nas/">

      <nas:sessionid xsi:type="xsd:string">session id from login</nas:sessionid>

    </nas:list_imageset>

  </SOAP-ENV:Body>

</SOAP-ENV:Envelope>


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:
  • 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


<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:list_int xmlns:nas="http://opsware.com/nas/">

      <nas:sessionid xsi:type="xsd:string">session id from login</nas:sessionid>

      <nas:ip xsi:type="xsd:string">ipaddress</nas:ip>

      <!-- Note: host or fqdn can be sent instead of ip -->

      <!-- Optional arguments -->

      <nas:end xsi:type="xsd:string">endDate</nas:end>

      <nas:start xsi:type="xsd:string">startDate</nas:start>

    </nas:list_int>

  </SOAP-ENV:Body>

</SOAP-ENV:Envelope>


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


<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:list_ip xmlns:nas="http://opsware.com/nas/">

      <nas:sessionid xsi:type="xsd:string">session id from login</nas:sessionid>

      <nas:deviceip xsi:type="xsd:string">device ip address</nas:deviceip>

    </nas:list_ip>

  </SOAP-ENV:Body>

</SOAP-ENV:Envelope>


list_ip_all

List all secondary ip.

Description

List all secondary ip addresses in the system.

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:list_ip_all xmlns:nas="http://opsware.com/nas/">

      <nas:sessionid xsi:type="xsd:string">session id from login</nas:sessionid>

    </nas:list_ip_all>

  </SOAP-ENV:Body>

</SOAP-ENV:Envelope>


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


<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:list_metadata xmlns:nas="http://opsware.com/nas/">

      <nas:sessionid xsi:type="xsd:string">session id from login</nas:sessionid>

      <nas:associatedtableid xsi:type="xsd:string">0</nas:associatedtableid>

      <nas:table xsi:type="xsd:string">table name</nas:table>

    </nas:list_metadata>

  </SOAP-ENV:Body>

</SOAP-ENV:Envelope>


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


<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:list_metadata_field xmlns:nas="http://opsware.com/nas/">

      <nas:sessionid xsi:type="xsd:string">session id from login</nas:sessionid>

      <nas:table xsi:type="xsd:string">table</nas:table>

    </nas:list_metadata_field>

  </SOAP-ENV:Body>

</SOAP-ENV:Envelope>


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


<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:list_module xmlns:nas="http://opsware.com/nas/">

      <nas:sessionid xsi:type="xsd:string">session id from login</nas:sessionid>

      <!-- Optional arguments -->

      <nas:comment xsi:type="xsd:string">comment</nas:comment>

      <nas:firmware xsi:type="xsd:string">firmware</nas:firmware>

      <nas:group xsi:type="xsd:string">group</nas:group>

      <nas:hardware xsi:type="xsd:string">hardware</nas:hardware>

      <nas:ip xsi:type="xsd:string">ipaddress</nas:ip>

      <!-- Note: host or fqdn can be sent instead of ip -->

      <nas:memory xsi:type="xsd:string">memory</nas:memory>

      <nas:model xsi:type="xsd:string">model</nas:model>

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

    </nas:list_module>

  </SOAP-ENV:Body>

</SOAP-ENV:Envelope>


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:
  • 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


<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:list_ospfneighbor xmlns:nas="http://opsware.com/nas/">

      <nas:sessionid xsi:type="xsd:string">session id from login</nas:sessionid>

      <nas:ip xsi:type="xsd:string">ipaddress</nas:ip>

      <!-- Note: host or fqdn can be sent instead of ip -->

      <!-- Optional arguments -->

      <nas:end xsi:type="xsd:string">endDate</nas:end>

      <nas:start xsi:type="xsd:string">startDate</nas:start>

    </nas:list_ospfneighbor>

  </SOAP-ENV:Body>

</SOAP-ENV:Envelope>


list_partition

Show details for a single view.

Description

Show details for a single parition.

  • viewname - The View Name to show.

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:list_partition xmlns:nas="http://opsware.com/nas/">

      <nas:sessionid xsi:type="xsd:string">session id from login</nas:sessionid>

      <nas:viewname xsi:type="xsd:string">viewName</nas:viewname>

    </nas:list_partition>

  </SOAP-ENV:Body>

</SOAP-ENV:Envelope>


list_policy_id

Lists IDs of all policies that apply to a given device

Description

  • deviceid - device id

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:list_policy_id xmlns:nas="http://opsware.com/nas/">

      <nas:sessionid xsi:type="xsd:string">session id from login</nas:sessionid>

      <nas:deviceid xsi:type="xsd:string">0</nas:deviceid>

    </nas:list_policy_id>

  </SOAP-ENV:Body>

</SOAP-ENV:Envelope>


list_policy_rule

Lists all rules of a policy

Description

  • policyid - policy id

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:list_policy_rule xmlns:nas="http://opsware.com/nas/">

      <nas:sessionid xsi:type="xsd:string">session id from login</nas:sessionid>

      <nas:policyid xsi:type="xsd:string">0</nas:policyid>

    </nas:list_policy_rule>

  </SOAP-ENV:Body>

</SOAP-ENV:Envelope>


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


<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:list_port xmlns:nas="http://opsware.com/nas/">

      <nas:sessionid xsi:type="xsd:string">session id from login</nas:sessionid>

      <!-- Optional arguments -->

      <nas:ip xsi:type="xsd:string">ipaddress</nas:ip>

      <!-- Note: host or fqdn can be sent instead of ip -->

    </nas:list_port>

  </SOAP-ENV:Body>

</SOAP-ENV:Envelope>


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:
  • 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


<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:list_routing xmlns:nas="http://opsware.com/nas/">

      <nas:sessionid xsi:type="xsd:string">session id from login</nas:sessionid>

      <nas:ip xsi:type="xsd:string">ipaddress</nas:ip>

      <!-- Note: host or fqdn can be sent instead of ip -->

      <!-- Optional arguments -->

      <nas:end xsi:type="xsd:string">endDate</nas:end>

      <nas:start xsi:type="xsd:string">startDate</nas:start>

    </nas:list_routing>

  </SOAP-ENV:Body>

</SOAP-ENV:Envelope>


list_rule_condition

Lists all conditions of a policy rule

Description

  • ruleid - rule id

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:list_rule_condition xmlns:nas="http://opsware.com/nas/">

      <nas:sessionid xsi:type="xsd:string">session id from login</nas:sessionid>

      <nas:ruleid xsi:type="xsd:string">0</nas:ruleid>

    </nas:list_rule_condition>

  </SOAP-ENV:Body>

</SOAP-ENV:Envelope>


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


<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:list_script xmlns:nas="http://opsware.com/nas/">

      <nas:sessionid xsi:type="xsd:string">session id from login</nas:sessionid>

      <!-- Optional arguments -->

      <nas:ids xsi:type="xsd:string">id list</nas:ids>

      <nas:mode xsi:type="xsd:string">mode</nas:mode>

      <nas:name xsi:type="xsd:string">name</nas:name>

      <nas:scripttype xsi:type="xsd:string">script type</nas:scripttype>

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

    </nas:list_script>

  </SOAP-ENV:Body>

</SOAP-ENV:Envelope>


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


<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:list_script_id xmlns:nas="http://opsware.com/nas/">

      <nas:sessionid xsi:type="xsd:string">session id from login</nas:sessionid>

      <!-- Optional arguments -->

      <nas:id xsi:type="xsd:string">id</nas:id>

      <nas:mode xsi:type="xsd:string">mode</nas:mode>

      <nas:name xsi:type="xsd:string">name</nas:name>

      <nas:scripttype xsi:type="xsd:string">script type</nas:scripttype>

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

    </nas:list_script_id>

  </SOAP-ENV:Body>

</SOAP-ENV:Envelope>


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


<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:list_script_mode xmlns:nas="http://opsware.com/nas/">

      <nas:sessionid xsi:type="xsd:string">session id from login</nas:sessionid>

      <!-- Optional arguments -->

      <nas:id xsi:type="xsd:string">device ID</nas:id>

      <nas:ip xsi:type="xsd:string">ipaddress</nas:ip>

      <!-- Note: host or fqdn can be sent instead of ip -->

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

    </nas:list_script_mode>

  </SOAP-ENV:Body>

</SOAP-ENV:Envelope>


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:
  • 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


<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:list_session xmlns:nas="http://opsware.com/nas/">

      <nas:sessionid xsi:type="xsd:string">session id from login</nas:sessionid>

      <nas:ip xsi:type="xsd:string">ipaddress</nas:ip>

      <!-- Note: host or fqdn can be sent instead of ip -->

      <!-- Optional arguments -->

      <nas:end xsi:type="xsd:string">endDate</nas:end>

      <nas:start xsi:type="xsd:string">startDate</nas:start>

    </nas:list_session>

  </SOAP-ENV:Body>

</SOAP-ENV:Envelope>


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


<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:list_site xmlns:nas="http://opsware.com/nas/">

      <nas:sessionid xsi:type="xsd:string">session id from login</nas:sessionid>

      <!-- Optional arguments -->

      <nas:id xsi:type="xsd:string">id</nas:id>

      <nas:name xsi:type="xsd:string">name</nas:name>

    </nas:list_site>

  </SOAP-ENV:Body>

</SOAP-ENV:Envelope>


list_sys_oids_all

List all sys oids supported by the system.

Description

List all sys oids in the system.

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:list_sys_oids_all xmlns:nas="http://opsware.com/nas/">

      <nas:sessionid xsi:type="xsd:string">session id from login</nas:sessionid>

    </nas:list_sys_oids_all>

  </SOAP-ENV:Body>

</SOAP-ENV:Envelope>


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:
  • 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


<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:list_system_message xmlns:nas="http://opsware.com/nas/">

      <nas:sessionid xsi:type="xsd:string">session id from login</nas:sessionid>

      <!-- Optional arguments -->

      <nas:end xsi:type="xsd:string">endDate</nas:end>

      <nas:ip xsi:type="xsd:string">ipaddress</nas:ip>

      <!-- Note: host or fqdn can be sent instead of ip -->

      <nas:start xsi:type="xsd:string">startDate</nas:start>

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

    </nas:list_system_message>

  </SOAP-ENV:Body>

</SOAP-ENV:Envelope>


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


<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:list_task xmlns:nas="http://opsware.com/nas/">

      <nas:sessionid xsi:type="xsd:string">session id from login</nas:sessionid>

      <!-- Optional arguments -->

      <nas:end xsi:type="xsd:string">YYYY:MM:DD:HH:mm</nas:end>

      <nas:id xsi:type="xsd:string">task id</nas:id>

      <nas:ip xsi:type="xsd:string">ipaddress</nas:ip>

      <!-- Note: host or fqdn can be sent instead of ip -->

      <nas:parentid xsi:type="xsd:string">parent task id</nas:parentid>

      <nas:start xsi:type="xsd:string">YYYY:MM:DD:HH:mm</nas:start>

      <nas:status xsi:type="xsd:string">status</nas:status>

    </nas:list_task>

  </SOAP-ENV:Body>

</SOAP-ENV:Envelope>


list_task_all

List all tasks.

Description

Equivalent to "list task".

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:list_task_all xmlns:nas="http://opsware.com/nas/">

      <nas:sessionid xsi:type="xsd:string">session id from login</nas:sessionid>

    </nas:list_task_all>

  </SOAP-ENV:Body>

</SOAP-ENV:Envelope>


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


<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:list_topology xmlns:nas="http://opsware.com/nas/">

      <nas:sessionid xsi:type="xsd:string">session id from login</nas:sessionid>

      <!-- Optional arguments -->

      <nas:ip xsi:type="xsd:string">ipaddress</nas:ip>

      <!-- Note: host or fqdn can be sent instead of ip -->

      <nas:mac xsi:type="xsd:string">macaddress</nas:mac>

    </nas:list_topology>

  </SOAP-ENV:Body>

</SOAP-ENV:Envelope>


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


<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:list_topology_graph xmlns:nas="http://opsware.com/nas/">

      <nas:sessionid xsi:type="xsd:string">session id from login</nas:sessionid>

      <!-- Optional arguments -->

      <nas:deviceid xsi:type="xsd:string">0</nas:deviceid>

      <nas:deviceids xsi:type="xsd:string">deviceids</nas:deviceids>

      <nas:deviceportids xsi:type="xsd:string">deviceportids</nas:deviceportids>

      <nas:endip xsi:type="xsd:string">endip</nas:endip>

      <nas:hideinactive xsi:type="xsd:string">hideinactive</nas:hideinactive>

      <nas:hideunconnected xsi:type="xsd:string">hideunconnected</nas:hideunconnected>

      <nas:hideunmanaged xsi:type="xsd:string">hideunmanaged</nas:hideunmanaged>

      <nas:hierarchylayer xsi:type="xsd:string">hierarchylayer</nas:hierarchylayer>

      <nas:hopcount xsi:type="xsd:string">0</nas:hopcount>

      <nas:layer xsi:type="xsd:string">layer</nas:layer>

      <nas:serverids xsi:type="xsd:string">serverids</nas:serverids>

      <nas:serverportids xsi:type="xsd:string">serverportids</nas:serverportids>

      <nas:startip xsi:type="xsd:string">startip</nas:startip>

      <nas:type xsi:type="xsd:string">(phy_inferred|nearest)</nas:type>

    </nas:list_topology_graph>

  </SOAP-ENV:Body>

</SOAP-ENV:Envelope>


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


<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:list_topology_ip xmlns:nas="http://opsware.com/nas/">

      <nas:sessionid xsi:type="xsd:string">session id from login</nas:sessionid>

      <!-- Optional arguments -->

      <nas:address xsi:type="xsd:string">(all|internal|connected)</nas:address>

      <nas:deviceid xsi:type="xsd:string">0</nas:deviceid>

      <nas:deviceip xsi:type="xsd:string">ipaddress</nas:deviceip>

      <nas:notcurrent xsi:type="xsd:string">not currently seen</nas:notcurrent>

      <nas:portid xsi:type="xsd:string">0</nas:portid>

      <nas:serverid xsi:type="xsd:string">server ID</nas:serverid>

      <nas:serverportid xsi:type="xsd:string">server interface ID</nas:serverportid>

      <nas:type xsi:type="xsd:string">(all|internal|connected)</nas:type>

    </nas:list_topology_ip>

  </SOAP-ENV:Body>

</SOAP-ENV:Envelope>


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


<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:list_topology_mac xmlns:nas="http://opsware.com/nas/">

      <nas:sessionid xsi:type="xsd:string">session id from login</nas:sessionid>

      <!-- Optional arguments -->

      <nas:address xsi:type="xsd:string">(all|internal|connected)</nas:address>

      <nas:deviceid xsi:type="xsd:string">0</nas:deviceid>

      <nas:deviceip xsi:type="xsd:string">ipaddress</nas:deviceip>

      <nas:notcurrent xsi:type="xsd:string">not currently seen</nas:notcurrent>

      <nas:portid xsi:type="xsd:string">0</nas:portid>

      <nas:serverid xsi:type="xsd:string">server ID</nas:serverid>

      <nas:serverportid xsi:type="xsd:string">server interface ID</nas:serverportid>

      <nas:type xsi:type="xsd:string">(all|internal|connected)</nas:type>

    </nas:list_topology_mac>

  </SOAP-ENV:Body>

</SOAP-ENV:Envelope>


list_user

List all users.

Description

List all users known to the system.

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:list_user xmlns:nas="http://opsware.com/nas/">

      <nas:sessionid xsi:type="xsd:string">session id from login</nas:sessionid>

      <!-- Optional arguments -->

      <nas:group xsi:type="xsd:string">group</nas:group>

    </nas:list_user>

  </SOAP-ENV:Body>

</SOAP-ENV:Envelope>


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


<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:list_user_id xmlns:nas="http://opsware.com/nas/">

      <nas:sessionid xsi:type="xsd:string">session id from login</nas:sessionid>

      <!-- Optional arguments -->

      <nas:viewable_by xsi:type="xsd:string">0</nas:viewable_by>

    </nas:list_user_id>

  </SOAP-ENV:Body>

</SOAP-ENV:Envelope>


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


<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:list_view xmlns:nas="http://opsware.com/nas/">

      <nas:sessionid xsi:type="xsd:string">session id from login</nas:sessionid>

    </nas:list_view>

  </SOAP-ENV:Body>

</SOAP-ENV:Envelope>


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


<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:list_vlan xmlns:nas="http://opsware.com/nas/">

      <nas:sessionid xsi:type="xsd:string">session id from login</nas:sessionid>

      <nas:deviceip xsi:type="xsd:string">ipaddress</nas:deviceip>

    </nas:list_vlan>

  </SOAP-ENV:Body>

</SOAP-ENV:Envelope>


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


<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:list_vlan_ports xmlns:nas="http://opsware.com/nas/">

      <nas:sessionid xsi:type="xsd:string">session id from login</nas:sessionid>

      <nas:id xsi:type="xsd:string">vlan id</nas:id>

    </nas:list_vlan_ports>

  </SOAP-ENV:Body>

</SOAP-ENV:Envelope>


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


<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:logout xmlns:nas="http://opsware.com/nas/">

      <nas:sessionid xsi:type="xsd:string">session id from login</nas:sessionid>

    </nas:logout>

  </SOAP-ENV:Body>

</SOAP-ENV:Envelope>


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


<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:mod_advanced_script xmlns:nas="http://opsware.com/nas/">

      <nas:sessionid xsi:type="xsd:string">session id from login</nas:sessionid>

      <nas:driver xsi:type="xsd:string"></nas:driver>

      <nas:type xsi:type="xsd:string">advanced</nas:type>

      <!-- Optional arguments -->

      <nas:description xsi:type="xsd:string">description</nas:description>

      <nas:family xsi:type="xsd:string">device family</nas:family>

      <nas:id xsi:type="xsd:string">id</nas:id>

      <nas:language xsi:type="xsd:string">script language</nas:language>

      <nas:name xsi:type="xsd:string">name</nas:name>

      <nas:newname xsi:type="xsd:string">new script name</nas:newname>

      <nas:parameters xsi:type="xsd:string">script parameters</nas:parameters>

      <nas:script xsi:type="xsd:string">script</nas:script>

      <nas:scripttype xsi:type="xsd:string">script type</nas:scripttype>

    </nas:mod_advanced_script>

  </SOAP-ENV:Body>

</SOAP-ENV:Envelope>


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


<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:mod_authentication xmlns:nas="http://opsware.com/nas/">

      <nas:sessionid xsi:type="xsd:string">session id from login</nas:sessionid>

      <nas:loc xsi:type="xsd:string">(device|group|db)</nas:loc>

      <!-- Optional arguments -->

      <nas:accessvariables xsi:type="xsd:string">access variables</nas:accessvariables>

      <nas:appendsnmpro xsi:type="xsd:string">append to read only community strings?</nas:appendsnmpro>

      <nas:appendsnmprw xsi:type="xsd:string">append to read write community strings?</nas:appendsnmprw>

      <nas:connectionmethods xsi:type="xsd:string">connection methods</nas:connectionmethods>

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

      <nas:enableuser xsi:type="xsd:string">enable mode username</nas:enableuser>

      <nas:group xsi:type="xsd:string">name of device group</nas:group>

      <nas:ip xsi:type="xsd:string">ipaddress</nas:ip>

      <!-- Note: host or fqdn can be sent instead of ip -->

      <nas:iprangeend xsi:type="xsd:string">ip end range</nas:iprangeend>

      <nas:iprangestart xsi:type="xsd:string">ip start range</nas:iprangestart>

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

      <nas:ruledevicegroup xsi:type="xsd:string">device group</nas:ruledevicegroup>

      <nas:rulehostname xsi:type="xsd:string">Host name></nas:rulehostname>

      <nas:rulename xsi:type="xsd:string">password rule to modify</nas:rulename>

      <nas:snmpro xsi:type="xsd:string">read-only community string</nas:snmpro>

      <nas:snmprw xsi:type="xsd:string">read-write community string</nas:snmprw>

      <nas:snmpv3authpw xsi:type="xsd:string">SNMPv3 authentication password</nas:snmpv3authpw>

      <nas:snmpv3encryptpw xsi:type="xsd:string">SNMPv3 encryption password</nas:snmpv3encryptpw>

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

      <nas:start xsi:type="xsd:string">YYYY:MM:DD:HH:mm</nas:start>

      <nas:sync xsi:type="xsd:string">execute synchronously?</nas:sync>

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

    </nas:mod_authentication>

  </SOAP-ENV:Body>

</SOAP-ENV:Envelope>


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


<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:mod_command_script xmlns:nas="http://opsware.com/nas/">

      <nas:sessionid xsi:type="xsd:string">session id from login</nas:sessionid>

      <nas:type xsi:type="xsd:string">command</nas:type>

      <!-- Optional arguments -->

      <nas:description xsi:type="xsd:string">description</nas:description>

      <nas:driver xsi:type="xsd:string">driver</nas:driver>

      <nas:id xsi:type="xsd:string">id</nas:id>

      <nas:mode xsi:type="xsd:string">custom action mode</nas:mode>

      <nas:name xsi:type="xsd:string">name</nas:name>

      <nas:newname xsi:type="xsd:string">new script name</nas:newname>

      <nas:script xsi:type="xsd:string">script</nas:script>

      <nas:scripttype xsi:type="xsd:string">script type</nas:scripttype>

    </nas:mod_command_script>

  </SOAP-ENV:Body>

</SOAP-ENV:Envelope>


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


<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:mod_device xmlns:nas="http://opsware.com/nas/">

      <nas:sessionid xsi:type="xsd:string">session id from login</nas:sessionid>

      <nas:ip xsi:type="xsd:string">ipaddress</nas:ip>

      <!-- Note: host or fqdn can be sent instead of ip -->

      <!-- Optional arguments -->

      <nas:accessmethods xsi:type="xsd:string">supported access methods</nas:accessmethods>

      <nas:asset xsi:type="xsd:string">Asset Tag</nas:asset>

      <nas:comment xsi:type="xsd:string">Comment</nas:comment>

      <nas:consoleip xsi:type="xsd:string">Console IP Address</nas:consoleip>

      <nas:consoleport xsi:type="xsd:string">Console Port</nas:consoleport>

      <nas:customname xsi:type="xsd:string">custom field name</nas:customname>

      <nas:customvalue xsi:type="xsd:string">custom value</nas:customvalue>

      <nas:description xsi:type="xsd:string">Device Description</nas:description>

      <nas:domain xsi:type="xsd:string">primary FQDN</nas:domain>

      <nas:hierarchylayer xsi:type="xsd:string">hierarchy layer</nas:hierarchylayer>

      <nas:hostname xsi:type="xsd:string">Hostname</nas:hostname>

      <nas:location xsi:type="xsd:string">Location</nas:location>

      <nas:model xsi:type="xsd:string">Device Model</nas:model>

      <nas:natip xsi:type="xsd:string">NAT IP Address</nas:natip>

      <nas:newip xsi:type="xsd:string">new ipaddress</nas:newip>

      <nas:nopoll xsi:type="xsd:string">0</nas:nopoll>

      <nas:serial xsi:type="xsd:string">Serial Number</nas:serial>

      <nas:tftpserverip xsi:type="xsd:string">TFTP Server IP Address</nas:tftpserverip>

      <nas:unmanaged xsi:type="xsd:string">0</nas:unmanaged>

      <nas:useconsoleserver xsi:type="xsd:string">true=use console server</nas:useconsoleserver>

      <nas:vendor xsi:type="xsd:string">Vendor</nas:vendor>

    </nas:mod_device>

  </SOAP-ENV:Body>

</SOAP-ENV:Envelope>


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


<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:mod_diagnostic xmlns:nas="http://opsware.com/nas/">

      <nas:sessionid xsi:type="xsd:string">session id from login</nas:sessionid>

      <nas:type xsi:type="xsd:string">diagnostic</nas:type>

      <!-- Optional arguments -->

      <nas:description xsi:type="xsd:string">description</nas:description>

      <nas:driver xsi:type="xsd:string">driver</nas:driver>

      <nas:id xsi:type="xsd:string">id</nas:id>

      <nas:mode xsi:type="xsd:string">custom action mode</nas:mode>

      <nas:name xsi:type="xsd:string">name</nas:name>

      <nas:newname xsi:type="xsd:string">new diagnostic name</nas:newname>

      <nas:script xsi:type="xsd:string">script</nas:script>

    </nas:mod_diagnostic>

  </SOAP-ENV:Body>

</SOAP-ENV:Envelope>


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


<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:mod_group xmlns:nas="http://opsware.com/nas/">

      <nas:sessionid xsi:type="xsd:string">session id from login</nas:sessionid>

      <nas:name xsi:type="xsd:string">current group name</nas:name>

      <nas:type xsi:type="xsd:string">group type</nas:type>

      <!-- Optional arguments -->

      <nas:comment xsi:type="xsd:string">comment</nas:comment>

      <nas:customname xsi:type="xsd:string">custom field name</nas:customname>

      <nas:customvalue xsi:type="xsd:string">custom value</nas:customvalue>

      <nas:newname xsi:type="xsd:string">new group name</nas:newname>

      <nas:shared xsi:type="xsd:string">0</nas:shared>

    </nas:mod_group>

  </SOAP-ENV:Body>

</SOAP-ENV:Envelope>


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


<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:mod_ip xmlns:nas="http://opsware.com/nas/">

      <nas:sessionid xsi:type="xsd:string">session id from login</nas:sessionid>

      <nas:deviceip xsi:type="xsd:string">device ip address</nas:deviceip>

      <nas:ipvalue xsi:type="xsd:string">ip address value</nas:ipvalue>

      <!-- Optional arguments -->

      <nas:comment xsi:type="xsd:string">Comment</nas:comment>

      <nas:usetoaccess xsi:type="xsd:string">0</nas:usetoaccess>

    </nas:mod_ip>

  </SOAP-ENV:Body>

</SOAP-ENV:Envelope>


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


<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:mod_metadata xmlns:nas="http://opsware.com/nas/">

      <nas:sessionid xsi:type="xsd:string">session id from login</nas:sessionid>

      <nas:metadataid xsi:type="xsd:string">0</nas:metadataid>

      <!-- Optional arguments -->

      <nas:associatedtableid xsi:type="xsd:string">0</nas:associatedtableid>

      <nas:data xsi:type="xsd:string">data</nas:data>

      <nas:fieldid xsi:type="xsd:string">0</nas:fieldid>

    </nas:mod_metadata>

  </SOAP-ENV:Body>

</SOAP-ENV:Envelope>


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


<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:mod_metadata_field xmlns:nas="http://opsware.com/nas/">

      <nas:sessionid xsi:type="xsd:string">session id from login</nas:sessionid>

      <nas:fieldid xsi:type="xsd:string">0</nas:fieldid>

      <!-- Optional arguments -->

      <nas:associatedtable xsi:type="xsd:string">associated table</nas:associatedtable>

      <nas:fieldname xsi:type="xsd:string">field name</nas:fieldname>

      <nas:fieldvalues xsi:type="xsd:string">field values</nas:fieldvalues>

      <nas:flags xsi:type="xsd:string">0</nas:flags>

      <nas:inuse xsi:type="xsd:string">0</nas:inuse>

    </nas:mod_metadata_field>

  </SOAP-ENV:Body>

</SOAP-ENV:Envelope>


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


<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:mod_module xmlns:nas="http://opsware.com/nas/">

      <nas:sessionid xsi:type="xsd:string">session id from login</nas:sessionid>

      <nas:id xsi:type="xsd:string">id</nas:id>

      <!-- Optional arguments -->

      <nas:comment xsi:type="xsd:string">comment</nas:comment>

      <nas:customname xsi:type="xsd:string">custom field name</nas:customname>

      <nas:customvalue xsi:type="xsd:string">custom value</nas:customvalue>

    </nas:mod_module>

  </SOAP-ENV:Body>

</SOAP-ENV:Envelope>


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


<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:mod_partition xmlns:nas="http://opsware.com/nas/">

      <nas:sessionid xsi:type="xsd:string">session id from login</nas:sessionid>

      <nas:name xsi:type="xsd:string">current group name</nas:name>

      <!-- Optional arguments -->

      <nas:comment xsi:type="xsd:string">comment</nas:comment>

      <nas:newname xsi:type="xsd:string">new group name</nas:newname>

    </nas:mod_partition>

  </SOAP-ENV:Body>

</SOAP-ENV:Envelope>


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


<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:mod_port xmlns:nas="http://opsware.com/nas/">

      <nas:sessionid xsi:type="xsd:string">session id from login</nas:sessionid>

      <nas:id xsi:type="xsd:string">id</nas:id>

      <!-- Optional arguments -->

      <nas:comment xsi:type="xsd:string">comment</nas:comment>

      <nas:customname xsi:type="xsd:string">custom field name</nas:customname>

      <nas:customvalue xsi:type="xsd:string">custom value</nas:customvalue>

    </nas:mod_port>

  </SOAP-ENV:Body>

</SOAP-ENV:Envelope>


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


<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:mod_task xmlns:nas="http://opsware.com/nas/">

      <nas:sessionid xsi:type="xsd:string">session id from login</nas:sessionid>

      <nas:id xsi:type="xsd:string">taskid</nas:id>

      <!-- Optional arguments -->

      <nas:approve xsi:type="xsd:string">approve</nas:approve>

      <nas:comment xsi:type="xsd:string">comments</nas:comment>

      <nas:customname xsi:type="xsd:string">custom field name</nas:customname>

      <nas:customvalue xsi:type="xsd:string">custom value</nas:customvalue>

      <nas:days xsi:type="xsd:string">days to run</nas:days>

      <nas:duration xsi:type="xsd:string">duration</nas:duration>

      <nas:expensive xsi:type="xsd:string">mark task as expensive</nas:expensive>

      <nas:notexpensive xsi:type="xsd:string"> mark task as not expensive</nas:notexpensive>

      <nas:override xsi:type="xsd:string">override</nas:override>

      <nas:reject xsi:type="xsd:string">reject</nas:reject>

      <nas:repeatinterval xsi:type="xsd:string">Repeat Interval</nas:repeatinterval>

      <nas:repeattype xsi:type="xsd:string">RepeatType</nas:repeattype>

      <nas:retrycount xsi:type="xsd:string">retry count</nas:retrycount>

      <nas:retryinterval xsi:type="xsd:string">retry interval</nas:retryinterval>

      <nas:sessionlog xsi:type="xsd:string">(true|false)</nas:sessionlog>

      <nas:start xsi:type="xsd:string">start date</nas:start>

    </nas:mod_task>

  </SOAP-ENV:Body>

</SOAP-ENV:Envelope>


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


<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:mod_topology_graph xmlns:nas="http://opsware.com/nas/">

      <nas:sessionid xsi:type="xsd:string">session id from login</nas:sessionid>

      <nas:data xsi:type="xsd:string">data</nas:data>

      <nas:deviceid xsi:type="xsd:string">0</nas:deviceid>

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

      <!-- Optional arguments -->

      <nas:deviceportid xsi:type="xsd:string">0</nas:deviceportid>

      <nas:remotedeviceid xsi:type="xsd:string">0</nas:remotedeviceid>

      <nas:remotedeviceportid xsi:type="xsd:string">0</nas:remotedeviceportid>

      <nas:serverid xsi:type="xsd:string">serverid</nas:serverid>

      <nas:serverportid xsi:type="xsd:string">serverportid</nas:serverportid>

    </nas:mod_topology_graph>

  </SOAP-ENV:Body>

</SOAP-ENV:Envelope>


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


<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:mod_unmanaged_device xmlns:nas="http://opsware.com/nas/">

      <nas:sessionid xsi:type="xsd:string">session id from login</nas:sessionid>

      <nas:ip xsi:type="xsd:string">ipaddress</nas:ip>

      <!-- Note: host or fqdn can be sent instead of ip -->

      <!-- Optional arguments -->

      <nas:comment xsi:type="xsd:string">Comment</nas:comment>

    </nas:mod_unmanaged_device>

  </SOAP-ENV:Body>

</SOAP-ENV:Envelope>


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


<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:mod_user xmlns:nas="http://opsware.com/nas/">

      <nas:sessionid xsi:type="xsd:string">session id from login</nas:sessionid>

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

      <!-- Optional arguments -->

      <nas:aaapassword xsi:type="xsd:string">AAA Password</nas:aaapassword>

      <nas:aaausername xsi:type="xsd:string">AAA Username</nas:aaausername>

      <nas:customname xsi:type="xsd:string">custom field name</nas:customname>

      <nas:customvalue xsi:type="xsd:string">custom value</nas:customvalue>

      <nas:email xsi:type="xsd:string">Email</nas:email>

      <nas:extauthfailover xsi:type="xsd:string">Use External Auth Failover (yes|no)</nas:extauthfailover>

      <nas:fn xsi:type="xsd:string">FirstName</nas:fn>

      <nas:ln xsi:type="xsd:string">LastName</nas:ln>

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

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

      <nas:priv xsi:type="xsd:string">Privelege</nas:priv>

      <nas:status xsi:type="xsd:string">(enable|disable)</nas:status>

      <nas:useaaaloginforproxy xsi:type="xsd:string">Use AAA Login for Proxy (0|1)</nas:useaaaloginforproxy>

    </nas:mod_user>

  </SOAP-ENV:Body>

</SOAP-ENV:Envelope>


mod_version

Description

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:mod_version xmlns:nas="http://opsware.com/nas/">

      <nas:sessionid xsi:type="xsd:string">session id from login</nas:sessionid>

      <!-- Optional arguments -->

      <nas:add xsi:type="xsd:string">Version string to add</nas:add>

      <nas:remove xsi:type="xsd:string">Version string to remove</nas:remove>

    </nas:mod_version>

  </SOAP-ENV:Body>

</SOAP-ENV:Envelope>


passwd

Change current user's password.

Description

Causes the current user's password to be changed.

  • oldpwd - youroldpassword
  • newpwd - yournewpassword

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:passwd xmlns:nas="http://opsware.com/nas/">

      <nas:sessionid xsi:type="xsd:string">session id from login</nas:sessionid>

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

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

    </nas:passwd>

  </SOAP-ENV:Body>

</SOAP-ENV:Envelope>


pause_polling

Stop polling.

Description

Stop polling devices for configuration changes.

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:pause_polling xmlns:nas="http://opsware.com/nas/">

      <nas:sessionid xsi:type="xsd:string">session id from login</nas:sessionid>

    </nas:pause_polling>

  </SOAP-ENV:Body>

</SOAP-ENV:Envelope>


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


<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:ping xmlns:nas="http://opsware.com/nas/">

      <nas:sessionid xsi:type="xsd:string">session id from login</nas:sessionid>

      <nas:dest xsi:type="xsd:string">target IP addresses</nas:dest>

      <!-- Optional arguments -->

      <nas:async xsi:type="xsd:string">execute synchronously?</nas:async>

      <nas:rep xsi:type="xsd:string">repeat</nas:rep>

      <nas:source xsi:type="xsd:string">ipaddress</nas:source>

      <nas:sourcegroup xsi:type="xsd:string">source group</nas:sourcegroup>

      <nas:start xsi:type="xsd:string">YYYY:MM:DD:HH:mm</nas:start>

    </nas:ping>

  </SOAP-ENV:Body>

</SOAP-ENV:Envelope>


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


<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:reload_content xmlns:nas="http://opsware.com/nas/">

      <nas:sessionid xsi:type="xsd:string">session id from login</nas:sessionid>

    </nas:reload_content>

  </SOAP-ENV:Body>

</SOAP-ENV:Envelope>


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


<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:reload_drivers xmlns:nas="http://opsware.com/nas/">

      <nas:sessionid xsi:type="xsd:string">session id from login</nas:sessionid>

      <!-- Optional arguments -->

      <nas:force xsi:type="xsd:string">(true|false)</nas:force>

    </nas:reload_drivers>

  </SOAP-ENV:Body>

</SOAP-ENV:Envelope>


reload_server_options

Description

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

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:reload_server_options xmlns:nas="http://opsware.com/nas/">

      <nas:sessionid xsi:type="xsd:string">session id from login</nas:sessionid>

    </nas:reload_server_options>

  </SOAP-ENV:Body>

</SOAP-ENV:Envelope>


replication_start

Description

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:replication_start xmlns:nas="http://opsware.com/nas/">

      <nas:sessionid xsi:type="xsd:string">session id from login</nas:sessionid>

    </nas:replication_start>

  </SOAP-ENV:Body>

</SOAP-ENV:Envelope>


replication_status

Description

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:replication_status xmlns:nas="http://opsware.com/nas/">

      <nas:sessionid xsi:type="xsd:string">session id from login</nas:sessionid>

    </nas:replication_status>

  </SOAP-ENV:Body>

</SOAP-ENV:Envelope>


replication_stop

Description

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:replication_stop xmlns:nas="http://opsware.com/nas/">

      <nas:sessionid xsi:type="xsd:string">session id from login</nas:sessionid>

    </nas:replication_stop>

  </SOAP-ENV:Body>

</SOAP-ENV:Envelope>


replication_sync

Description

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:replication_sync xmlns:nas="http://opsware.com/nas/">

      <nas:sessionid xsi:type="xsd:string">session id from login</nas:sessionid>

    </nas:replication_sync>

  </SOAP-ENV:Body>

</SOAP-ENV:Envelope>


resume_polling

Resume polling.

Description

Resume polling devices for configuration changes.

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:resume_polling xmlns:nas="http://opsware.com/nas/">

      <nas:sessionid xsi:type="xsd:string">session id from login</nas:sessionid>

    </nas:resume_polling>

  </SOAP-ENV:Body>

</SOAP-ENV:Envelope>


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


<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:run_advanced_script xmlns:nas="http://opsware.com/nas/">

      <nas:sessionid xsi:type="xsd:string">session id from login</nas:sessionid>

      <nas:linebyline xsi:type="xsd:string"></nas:linebyline>

      <nas:name xsi:type="xsd:string">script name</nas:name>

      <nas:type xsi:type="xsd:string">advanced</nas:type>

      <!-- Optional arguments -->

      <nas:comment xsi:type="xsd:string">comment</nas:comment>

      <nas:group xsi:type="xsd:string">device group</nas:group>

      <nas:ip xsi:type="xsd:string">ipaddress</nas:ip>

      <!-- Note: host or fqdn can be sent instead of ip -->

      <nas:nowait xsi:type="xsd:string">don't wait if other tasks are running</nas:nowait>

      <nas:parameters xsi:type="xsd:string">parameters</nas:parameters>

      <nas:postsnapshot xsi:type="xsd:string">(true|false|task)</nas:postsnapshot>

      <nas:presnapshot xsi:type="xsd:string">(true|false)</nas:presnapshot>

      <nas:rep xsi:type="xsd:string">repeat</nas:rep>

      <nas:start xsi:type="xsd:string">YYYY:MM:DD:HH:mm</nas:start>

      <nas:sync xsi:type="xsd:string">execute synchronously?</nas:sync>

      <nas:variables xsi:type="xsd:string">list of variable names and values</nas:variables>

    </nas:run_advanced_script>

  </SOAP-ENV:Body>

</SOAP-ENV:Envelope>


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


<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:run_checkdb xmlns:nas="http://opsware.com/nas/">

      <nas:sessionid xsi:type="xsd:string">session id from login</nas:sessionid>

      <!-- Optional arguments -->

      <nas:fix xsi:type="xsd:string">correct found problems</nas:fix>

      <nas:verbose xsi:type="xsd:string">display verbose output</nas:verbose>

    </nas:run_checkdb>

  </SOAP-ENV:Body>

</SOAP-ENV:Envelope>


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


<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:run_command_script xmlns:nas="http://opsware.com/nas/">

      <nas:sessionid xsi:type="xsd:string">session id from login</nas:sessionid>

      <nas:name xsi:type="xsd:string">script name</nas:name>

      <nas:parameters xsi:type="xsd:string"></nas:parameters>

      <nas:type xsi:type="xsd:string">command</nas:type>

      <!-- Optional arguments -->

      <nas:comment xsi:type="xsd:string">comment</nas:comment>

      <nas:group xsi:type="xsd:string">device group</nas:group>

      <nas:ip xsi:type="xsd:string">ipaddress</nas:ip>

      <!-- Note: host or fqdn can be sent instead of ip -->

      <nas:linebyline xsi:type="xsd:string">run scripts line-by-line (when applicable)</nas:linebyline>

      <nas:nowait xsi:type="xsd:string">don't wait if other tasks are running</nas:nowait>

      <nas:postsnapshot xsi:type="xsd:string">(true|false|task)</nas:postsnapshot>

      <nas:presnapshot xsi:type="xsd:string">(true|false)</nas:presnapshot>

      <nas:rep xsi:type="xsd:string">repeat</nas:rep>

      <nas:start xsi:type="xsd:string">YYYY:MM:DD:HH:mm</nas:start>

      <nas:sync xsi:type="xsd:string">execute synchronously?</nas:sync>

      <nas:variables xsi:type="xsd:string">list of variable names and values</nas:variables>

    </nas:run_command_script>

  </SOAP-ENV:Body>

</SOAP-ENV:Envelope>


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


<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:run_diagnostic xmlns:nas="http://opsware.com/nas/">

      <nas:sessionid xsi:type="xsd:string">session id from login</nas:sessionid>

      <nas:diagnostic xsi:type="xsd:string">custom diagnostic nam</nas:diagnostic>

      <!-- Optional arguments -->

      <nas:comment xsi:type="xsd:string">comment</nas:comment>

      <nas:group xsi:type="xsd:string">device group</nas:group>

      <nas:ip xsi:type="xsd:string">ipaddress</nas:ip>

      <!-- Note: host or fqdn can be sent instead of ip -->

      <nas:rep xsi:type="xsd:string">repeat</nas:rep>

      <nas:start xsi:type="xsd:string">YYYY:MM:DD:HH:mm</nas:start>

      <nas:sync xsi:type="xsd:string">execute synchronously?</nas:sync>

    </nas:run_diagnostic>

  </SOAP-ENV:Body>

</SOAP-ENV:Envelope>


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


<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:run_external_application xmlns:nas="http://opsware.com/nas/">

      <nas:sessionid xsi:type="xsd:string">session id from login</nas:sessionid>

      <nas:app xsi:type="xsd:string">app</nas:app>

      <!-- Optional arguments -->

      <nas:comment xsi:type="xsd:string">comment</nas:comment>

      <nas:errorifnonzero xsi:type="xsd:string">error if nonzero result?</nas:errorifnonzero>

      <nas:rep xsi:type="xsd:string">repeat</nas:rep>

      <nas:resultfile xsi:type="xsd:string">resultfile</nas:resultfile>

      <nas:start xsi:type="xsd:string">YYYY:MM:DD:HH:mm</nas:start>

      <nas:startdir xsi:type="xsd:string">startdir</nas:startdir>

      <nas:sync xsi:type="xsd:string">execute synchronously?</nas:sync>

    </nas:run_external_application>

  </SOAP-ENV:Body>

</SOAP-ENV:Envelope>


run_gc

Run the garbage collector.

Description

Recycle unused objects to increase the amount of free memory.

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:run_gc xmlns:nas="http://opsware.com/nas/">

      <nas:sessionid xsi:type="xsd:string">session id from login</nas:sessionid>

    </nas:run_gc>

  </SOAP-ENV:Body>

</SOAP-ENV:Envelope>


run_internal_test

Description

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:run_internal_test xmlns:nas="http://opsware.com/nas/">

      <nas:sessionid xsi:type="xsd:string">session id from login</nas:sessionid>

    </nas:run_internal_test>

  </SOAP-ENV:Body>

</SOAP-ENV:Envelope>


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


<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:run_script xmlns:nas="http://opsware.com/nas/">

      <nas:sessionid xsi:type="xsd:string">session id from login</nas:sessionid>

      <!-- Optional arguments -->

      <nas:comment xsi:type="xsd:string">comment</nas:comment>

      <nas:disablesessionlogging xsi:type="xsd:string">don'</nas:disablesessionlogging>

      <nas:group xsi:type="xsd:string">device group</nas:group>

      <nas:ip xsi:type="xsd:string">ipaddress</nas:ip>

      <!-- Note: host or fqdn can be sent instead of ip -->

      <nas:mode xsi:type="xsd:string">custom action mod</nas:mode>

      <nas:nowait xsi:type="xsd:string">don't wait if other tasks are running</nas:nowait>

      <nas:postsnapshot xsi:type="xsd:string">(true|false|task)</nas:postsnapshot>

      <nas:presnapshot xsi:type="xsd:string">(true|false)</nas:presnapshot>

      <nas:rep xsi:type="xsd:string">repeat</nas:rep>

      <nas:script xsi:type="xsd:string">script</nas:script>

      <nas:start xsi:type="xsd:string">YYYY:MM:DD:HH:mm</nas:start>

      <nas:sync xsi:type="xsd:string">execute synchronously?</nas:sync>

    </nas:run_script>

  </SOAP-ENV:Body>

</SOAP-ENV:Envelope>


schedule_task

Description

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:schedule_task xmlns:nas="http://opsware.com/nas/">

      <nas:sessionid xsi:type="xsd:string">session id from login</nas:sessionid>

      <nas:task xsi:type="xsd:string">task</nas:task>

      <nas:type xsi:type="xsd:string">task type</nas:type>

      <!-- Optional arguments -->

      <nas:comment xsi:type="xsd:string">comments</nas:comment>

      <nas:expensive xsi:type="xsd:string">expensive?</nas:expensive>

      <nas:retrycount xsi:type="xsd:string">retry count</nas:retrycount>

      <nas:retryinterval xsi:type="xsd:string">retry interval</nas:retryinterval>

      <nas:start xsi:type="xsd:string">start date</nas:start>

    </nas:schedule_task>

  </SOAP-ENV:Body>

</SOAP-ENV:Envelope>


schedule_task_daily

Description

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:schedule_task_daily xmlns:nas="http://opsware.com/nas/">

      <nas:sessionid xsi:type="xsd:string">session id from login</nas:sessionid>

      <nas:task xsi:type="xsd:string">task</nas:task>

      <nas:type xsi:type="xsd:string">task type</nas:type>

      <!-- Optional arguments -->

      <nas:comment xsi:type="xsd:string">comments</nas:comment>

      <nas:expensive xsi:type="xsd:string">expensive?</nas:expensive>

      <nas:retrycount xsi:type="xsd:string">retry count</nas:retrycount>

      <nas:retryinterval xsi:type="xsd:string">retry interval</nas:retryinterval>

      <nas:start xsi:type="xsd:string">start date</nas:start>

    </nas:schedule_task_daily>

  </SOAP-ENV:Body>

</SOAP-ENV:Envelope>


schedule_task_monthly

Description

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:schedule_task_monthly xmlns:nas="http://opsware.com/nas/">

      <nas:sessionid xsi:type="xsd:string">session id from login</nas:sessionid>

      <nas:days xsi:type="xsd:string">days of month</nas:days>

      <nas:task xsi:type="xsd:string">task</nas:task>

      <nas:type xsi:type="xsd:string">task type</nas:type>

      <!-- Optional arguments -->

      <nas:comment xsi:type="xsd:string">comments</nas:comment>

      <nas:expensive xsi:type="xsd:string">expensive?</nas:expensive>

      <nas:retrycount xsi:type="xsd:string">retry count</nas:retrycount>

      <nas:retryinterval xsi:type="xsd:string">retry interval</nas:retryinterval>

      <nas:start xsi:type="xsd:string">start date</nas:start>

    </nas:schedule_task_monthly>

  </SOAP-ENV:Body>

</SOAP-ENV:Envelope>


schedule_task_periodic

Description

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:schedule_task_periodic xmlns:nas="http://opsware.com/nas/">

      <nas:sessionid xsi:type="xsd:string">session id from login</nas:sessionid>

      <nas:repeat xsi:type="xsd:string">repeat interval</nas:repeat>

      <nas:task xsi:type="xsd:string">task</nas:task>

      <nas:type xsi:type="xsd:string">task type</nas:type>

      <!-- Optional arguments -->

      <nas:comment xsi:type="xsd:string">comments</nas:comment>

      <nas:expensive xsi:type="xsd:string">expensive?</nas:expensive>

      <nas:retrycount xsi:type="xsd:string">retry count</nas:retrycount>

      <nas:retryinterval xsi:type="xsd:string">retry interval</nas:retryinterval>

      <nas:start xsi:type="xsd:string">start date</nas:start>

    </nas:schedule_task_periodic>

  </SOAP-ENV:Body>

</SOAP-ENV:Envelope>


schedule_task_weekly

Description

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:schedule_task_weekly xmlns:nas="http://opsware.com/nas/">

      <nas:sessionid xsi:type="xsd:string">session id from login</nas:sessionid>

      <nas:days xsi:type="xsd:string">days of week</nas:days>

      <nas:task xsi:type="xsd:string">task</nas:task>

      <nas:type xsi:type="xsd:string">task type</nas:type>

      <!-- Optional arguments -->

      <nas:comment xsi:type="xsd:string">comments</nas:comment>

      <nas:expensive xsi:type="xsd:string">expensive?</nas:expensive>

      <nas:retrycount xsi:type="xsd:string">retry count</nas:retrycount>

      <nas:retryinterval xsi:type="xsd:string">retry interval</nas:retryinterval>

      <nas:start xsi:type="xsd:string">start date</nas:start>

    </nas:schedule_task_weekly>

  </SOAP-ENV:Body>

</SOAP-ENV:Envelope>


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


<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:show_access xmlns:nas="http://opsware.com/nas/">

      <nas:sessionid xsi:type="xsd:string">session id from login</nas:sessionid>

      <nas:id xsi:type="xsd:string">configid</nas:id>

    </nas:show_access>

  </SOAP-ENV:Body>

</SOAP-ENV:Envelope>


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


<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:show_acl xmlns:nas="http://opsware.com/nas/">

      <nas:sessionid xsi:type="xsd:string">session id from login</nas:sessionid>

      <nas:id xsi:type="xsd:string">device acl id</nas:id>

    </nas:show_acl>

  </SOAP-ENV:Body>

</SOAP-ENV:Envelope>


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


<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:show_basicip xmlns:nas="http://opsware.com/nas/">

      <nas:sessionid xsi:type="xsd:string">session id from login</nas:sessionid>

      <!-- Optional arguments -->

      <nas:id xsi:type="xsd:string">id</nas:id>

      <nas:ip xsi:type="xsd:string">ipaddress</nas:ip>

      <!-- Note: host or fqdn can be sent instead of ip -->

    </nas:show_basicip>

  </SOAP-ENV:Body>

</SOAP-ENV:Envelope>


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


<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:show_config xmlns:nas="http://opsware.com/nas/">

      <nas:sessionid xsi:type="xsd:string">session id from login</nas:sessionid>

      <nas:id xsi:type="xsd:string">configid</nas:id>

      <!-- Optional arguments -->

      <nas:mask xsi:type="xsd:string">mask config?</nas:mask>

    </nas:show_config>

  </SOAP-ENV:Body>

</SOAP-ENV:Envelope>


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


<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:show_configlet xmlns:nas="http://opsware.com/nas/">

      <nas:sessionid xsi:type="xsd:string">session id from login</nas:sessionid>

      <nas:ip xsi:type="xsd:string">devic</nas:ip>

      <!-- Note: host or fqdn can be sent instead of ip -->

      <!-- Optional arguments -->

      <nas:end xsi:type="xsd:string">endBlock</nas:end>

      <nas:start xsi:type="xsd:string">start</nas:start>

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

    </nas:show_configlet>

  </SOAP-ENV:Body>

</SOAP-ENV:Envelope>


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


<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:show_device xmlns:nas="http://opsware.com/nas/">

      <nas:sessionid xsi:type="xsd:string">session id from login</nas:sessionid>

      <!-- Optional arguments -->

      <nas:id xsi:type="xsd:string">device ID</nas:id>

      <nas:ip xsi:type="xsd:string">ipaddress</nas:ip>

      <!-- Note: host or fqdn can be sent instead of ip -->

    </nas:show_device>

  </SOAP-ENV:Body>

</SOAP-ENV:Envelope>


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


<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:show_device_config xmlns:nas="http://opsware.com/nas/">

      <nas:sessionid xsi:type="xsd:string">session id from login</nas:sessionid>

      <nas:ip xsi:type="xsd:string">ipaddress</nas:ip>

      <!-- Note: host or fqdn can be sent instead of ip -->

    </nas:show_device_config>

  </SOAP-ENV:Body>

</SOAP-ENV:Envelope>


show_device_family

Show the family classification associated with 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.

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:show_device_family xmlns:nas="http://opsware.com/nas/">

      <nas:sessionid xsi:type="xsd:string">session id from login</nas:sessionid>

      <nas:ip xsi:type="xsd:string">ipaddress</nas:ip>

      <!-- Note: host or fqdn can be sent instead of ip -->

    </nas:show_device_family>

  </SOAP-ENV:Body>

</SOAP-ENV:Envelope>


show_device_latest_diff

Show the difference between two configs 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


<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:show_device_latest_diff xmlns:nas="http://opsware.com/nas/">

      <nas:sessionid xsi:type="xsd:string">session id from login</nas:sessionid>

      <nas:ip xsi:type="xsd:string">ipaddress</nas:ip>

      <!-- Note: host or fqdn can be sent instead of ip -->

    </nas:show_device_latest_diff>

  </SOAP-ENV:Body>

</SOAP-ENV:Envelope>


show_deviceinfo

Show a DeviceInformation model.

Description

If the -ip flag is given, show the DeviceInformation model for the most recent config for the specified device. If the -id flag is given, show the DeviceInformation 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


<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:show_deviceinfo xmlns:nas="http://opsware.com/nas/">

      <nas:sessionid xsi:type="xsd:string">session id from login</nas:sessionid>

      <!-- Optional arguments -->

      <nas:id xsi:type="xsd:string">id</nas:id>

      <nas:ip xsi:type="xsd:string">ipaddress</nas:ip>

      <!-- Note: host or fqdn can be sent instead of ip -->

    </nas:show_deviceinfo>

  </SOAP-ENV:Body>

</SOAP-ENV:Envelope>


show_diagnostic

Show a diagnostic's results.

Description

  • id - A diagnostic ID

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:show_diagnostic xmlns:nas="http://opsware.com/nas/">

      <nas:sessionid xsi:type="xsd:string">session id from login</nas:sessionid>

      <nas:id xsi:type="xsd:string">configid</nas:id>

    </nas:show_diagnostic>

  </SOAP-ENV:Body>

</SOAP-ENV:Envelope>


show_driver

Show the driver assigned to 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


<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:show_driver xmlns:nas="http://opsware.com/nas/">

      <nas:sessionid xsi:type="xsd:string">session id from login</nas:sessionid>

      <nas:ip xsi:type="xsd:string">ipaddress</nas:ip>

      <!-- Note: host or fqdn can be sent instead of ip -->

    </nas:show_driver>

  </SOAP-ENV:Body>

</SOAP-ENV:Envelope>


show_event

Display the details of an event.

Description

  • id - A valid event id

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:show_event xmlns:nas="http://opsware.com/nas/">

      <nas:sessionid xsi:type="xsd:string">session id from login</nas:sessionid>

      <nas:id xsi:type="xsd:string">id</nas:id>

    </nas:show_event>

  </SOAP-ENV:Body>

</SOAP-ENV:Envelope>


show_group

Show all information for a group.

Description

  • name - The group name for whom information will be displayed
  • id - The group id for whom information will be displayed

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:show_group xmlns:nas="http://opsware.com/nas/">

      <nas:sessionid xsi:type="xsd:string">session id from login</nas:sessionid>

      <!-- Optional arguments -->

      <nas:id xsi:type="xsd:string">id</nas:id>

      <nas:name xsi:type="xsd:string">name</nas:name>

    </nas:show_group>

  </SOAP-ENV:Body>

</SOAP-ENV:Envelope>


show_icmp

Show an ICMPTest model.

Description

If the -ip flag is given, show the ICMPTest model for the most recent config for the specified device. If the -id flag is given, show the ICMPTest model for the specified config. Include exactly one of the -id or -ip option.

  • 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


<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:show_icmp xmlns:nas="http://opsware.com/nas/">

      <nas:sessionid xsi:type="xsd:string">session id from login</nas:sessionid>

      <!-- Optional arguments -->

      <nas:id xsi:type="xsd:string">id</nas:id>

      <nas:ip xsi:type="xsd:string">ipaddress</nas:ip>

      <!-- Note: host or fqdn can be sent instead of ip -->

    </nas:show_icmp>

  </SOAP-ENV:Body>

</SOAP-ENV:Envelope>


show_int

Show a ShowInterfaces model.

Description

If the -ip flag is given, show the ShowInterfaces model for the most recent config for the specified device. If the -id flag is given, show the ShowInterfaces 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


<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:show_int xmlns:nas="http://opsware.com/nas/">

      <nas:sessionid xsi:type="xsd:string">session id from login</nas:sessionid>

      <!-- Optional arguments -->

      <nas:id xsi:type="xsd:string">id</nas:id>

      <nas:ip xsi:type="xsd:string">ipaddress</nas:ip>

      <!-- Note: host or fqdn can be sent instead of ip -->

    </nas:show_int>

  </SOAP-ENV:Body>

</SOAP-ENV:Envelope>


show_ip

Show a ip's properties.

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


<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:show_ip xmlns:nas="http://opsware.com/nas/">

      <nas:sessionid xsi:type="xsd:string">session id from login</nas:sessionid>

      <nas:deviceip xsi:type="xsd:string">device ip address</nas:deviceip>

      <nas:ipvalue xsi:type="xsd:string">ip address value</nas:ipvalue>

    </nas:show_ip>

  </SOAP-ENV:Body>

</SOAP-ENV:Envelope>


show_latest_access

Show the most recent access record 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

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:show_latest_access xmlns:nas="http://opsware.com/nas/">

      <nas:sessionid xsi:type="xsd:string">session id from login</nas:sessionid>

      <nas:ip xsi:type="xsd:string">ipaddress</nas:ip>

      <!-- Note: host or fqdn can be sent instead of ip -->

    </nas:show_latest_access>

  </SOAP-ENV:Body>

</SOAP-ENV:Envelope>


show_metadata

Show a specific piece of custom data.

Description

  • metadataid - ID of the custom data to show

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:show_metadata xmlns:nas="http://opsware.com/nas/">

      <nas:sessionid xsi:type="xsd:string">session id from login</nas:sessionid>

      <nas:metadataid xsi:type="xsd:string">0</nas:metadataid>

    </nas:show_metadata>

  </SOAP-ENV:Body>

</SOAP-ENV:Envelope>


show_metadata_field

Show a custom data field

Description

  • fieldid - ID of the custom data field to show

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:show_metadata_field xmlns:nas="http://opsware.com/nas/">

      <nas:sessionid xsi:type="xsd:string">session id from login</nas:sessionid>

      <nas:fieldid xsi:type="xsd:string">0</nas:fieldid>

    </nas:show_metadata_field>

  </SOAP-ENV:Body>

</SOAP-ENV:Envelope>


show_module

Show a module's properties.

Description

  • id - The ID of a module

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:show_module xmlns:nas="http://opsware.com/nas/">

      <nas:sessionid xsi:type="xsd:string">session id from login</nas:sessionid>

      <nas:id xsi:type="xsd:string">id</nas:id>

    </nas:show_module>

  </SOAP-ENV:Body>

</SOAP-ENV:Envelope>


show_ospfneighbor

Show a ShowOSPFNeighbors model.

Description

If the -ip flag is provided, show the ShowOSPFNeighbors model for the most recent config for the specified device. If the -id flag is given, show the ShowOSPFNeighbors 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


<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:show_ospfneighbor xmlns:nas="http://opsware.com/nas/">

      <nas:sessionid xsi:type="xsd:string">session id from login</nas:sessionid>

      <!-- Optional arguments -->

      <nas:id xsi:type="xsd:string">id</nas:id>

      <nas:ip xsi:type="xsd:string">ipaddress</nas:ip>

      <!-- Note: host or fqdn can be sent instead of ip -->

    </nas:show_ospfneighbor>

  </SOAP-ENV:Body>

</SOAP-ENV:Envelope>


show_permission

Display whether or not a user has permissions for a particular resource.

Description

  • resource - The name of a Command or Resource.
  • u - Username
  • id - User ID

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:show_permission xmlns:nas="http://opsware.com/nas/">

      <nas:sessionid xsi:type="xsd:string">session id from login</nas:sessionid>

      <nas:resource xsi:type="xsd:string">resource</nas:resource>

      <!-- Optional arguments -->

      <nas:id xsi:type="xsd:string">id</nas:id>

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

    </nas:show_permission>

  </SOAP-ENV:Body>

</SOAP-ENV:Envelope>


show_policy

Shows policy information

Description

  • id - policy id

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:show_policy xmlns:nas="http://opsware.com/nas/">

      <nas:sessionid xsi:type="xsd:string">session id from login</nas:sessionid>

      <nas:id xsi:type="xsd:string">policy id</nas:id>

    </nas:show_policy>

  </SOAP-ENV:Body>

</SOAP-ENV:Envelope>


show_policy_compliance

Shows policies and device compliance states

Description

  • policyid - policy id
  • deviceid - device id
  • compliance - compliance state (in|out|unknown)

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:show_policy_compliance xmlns:nas="http://opsware.com/nas/">

      <nas:sessionid xsi:type="xsd:string">session id from login</nas:sessionid>

      <!-- Optional arguments -->

      <nas:compliance xsi:type="xsd:string">(in|out|unknown)</nas:compliance>

      <nas:deviceid xsi:type="xsd:string">0</nas:deviceid>

      <nas:policyid xsi:type="xsd:string">0</nas:policyid>

    </nas:show_policy_compliance>

  </SOAP-ENV:Body>

</SOAP-ENV:Envelope>


show_policy_rule

Shows rule information

Description

  • id - rule id

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:show_policy_rule xmlns:nas="http://opsware.com/nas/">

      <nas:sessionid xsi:type="xsd:string">session id from login</nas:sessionid>

      <nas:id xsi:type="xsd:string">rule id</nas:id>

    </nas:show_policy_rule>

  </SOAP-ENV:Body>

</SOAP-ENV:Envelope>


show_polling_status

Show the current status of polling.

Description

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:show_polling_status xmlns:nas="http://opsware.com/nas/">

      <nas:sessionid xsi:type="xsd:string">session id from login</nas:sessionid>

    </nas:show_polling_status>

  </SOAP-ENV:Body>

</SOAP-ENV:Envelope>


show_port

Show a port's properties.

Description

  • id - The ID of a 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:show_port xmlns:nas="http://opsware.com/nas/">

      <nas:sessionid xsi:type="xsd:string">session id from login</nas:sessionid>

      <nas:id xsi:type="xsd:string">id</nas:id>

    </nas:show_port>

  </SOAP-ENV:Body>

</SOAP-ENV:Envelope>


show_routing

Display a routing table.

Description

If the -ip flag is given, show the most recent routing table captured for the specified device. If the -id flag is given, show the specified routing table. 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 routing table ID

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:show_routing xmlns:nas="http://opsware.com/nas/">

      <nas:sessionid xsi:type="xsd:string">session id from login</nas:sessionid>

      <!-- Optional arguments -->

      <nas:id xsi:type="xsd:string">configid</nas:id>

      <nas:ip xsi:type="xsd:string">IP address</nas:ip>

      <!-- Note: host or fqdn can be sent instead of ip -->

    </nas:show_routing>

  </SOAP-ENV:Body>

</SOAP-ENV:Envelope>


show_rule_condition

Shows rule condition information

Description

  • id - condition id

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:show_rule_condition xmlns:nas="http://opsware.com/nas/">

      <nas:sessionid xsi:type="xsd:string">session id from login</nas:sessionid>

      <nas:id xsi:type="xsd:string">rule condition id</nas:id>

    </nas:show_rule_condition>

  </SOAP-ENV:Body>

</SOAP-ENV:Envelope>


show_script

Show one command script, advanced script or diagnostic.

Description

Output 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


<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:show_script xmlns:nas="http://opsware.com/nas/">

      <nas:sessionid xsi:type="xsd:string">session id from login</nas:sessionid>

      <!-- Optional arguments -->

      <nas:id xsi:type="xsd:string">id</nas:id>

      <nas:name xsi:type="xsd:string">name</nas:name>

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

    </nas:show_script>

  </SOAP-ENV:Body>

</SOAP-ENV:Envelope>


show_server_option

Display the setting of a server option

Description

Display the value of an Admin Setting or server configuration option. If the option is not set and no default is provided then this command will fail.

  • name - The name of the server option.
  • default - The value to return if the option is not set.

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:show_server_option xmlns:nas="http://opsware.com/nas/">

      <nas:sessionid xsi:type="xsd:string">session id from login</nas:sessionid>

      <nas:name xsi:type="xsd:string">optionName</nas:name>

      <!-- Optional arguments -->

      <nas:default xsi:type="xsd:string">defaultValue</nas:default>

    </nas:show_server_option>

  </SOAP-ENV:Body>

</SOAP-ENV:Envelope>


show_session

Show interceptor log record.

Description

  • id - Interceptor log ID

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:show_session xmlns:nas="http://opsware.com/nas/">

      <nas:sessionid xsi:type="xsd:string">session id from login</nas:sessionid>

      <nas:id xsi:type="xsd:string">id</nas:id>

    </nas:show_session>

  </SOAP-ENV:Body>

</SOAP-ENV:Envelope>


show_session_commands

List all commands in interceptor log record.

Description

  • id - Interceptor log ID

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:show_session_commands xmlns:nas="http://opsware.com/nas/">

      <nas:sessionid xsi:type="xsd:string">session id from login</nas:sessionid>

      <nas:id xsi:type="xsd:string">id</nas:id>

    </nas:show_session_commands>

  </SOAP-ENV:Body>

</SOAP-ENV:Envelope>


show_snapshot

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


<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:show_snapshot xmlns:nas="http://opsware.com/nas/">

      <nas:sessionid xsi:type="xsd:string">session id from login</nas:sessionid>

      <nas:ip xsi:type="xsd:string">ipaddress</nas:ip>

      <!-- Note: host or fqdn can be sent instead of ip -->

    </nas:show_snapshot>

  </SOAP-ENV:Body>

</SOAP-ENV:Envelope>


show_system_message

Display the details of a system message.

Description

  • id - A valid system message id

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:show_system_message xmlns:nas="http://opsware.com/nas/">

      <nas:sessionid xsi:type="xsd:string">session id from login</nas:sessionid>

      <nas:id xsi:type="xsd:string">id</nas:id>

    </nas:show_system_message>

  </SOAP-ENV:Body>

</SOAP-ENV:Envelope>


show_task

Shows detailed information about a task.

Description

  • id - The task ID whose details will be displayed

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:show_task xmlns:nas="http://opsware.com/nas/">

      <nas:sessionid xsi:type="xsd:string">session id from login</nas:sessionid>

      <nas:id xsi:type="xsd:string">taskid</nas:id>

    </nas:show_task>

  </SOAP-ENV:Body>

</SOAP-ENV:Envelope>


show_topology

Show details for a single topology record.

Description

  • id - The id of the topology record to show.

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:show_topology xmlns:nas="http://opsware.com/nas/">

      <nas:sessionid xsi:type="xsd:string">session id from login</nas:sessionid>

      <nas:id xsi:type="xsd:string">id</nas:id>

    </nas:show_topology>

  </SOAP-ENV:Body>

</SOAP-ENV:Envelope>


show_user

Show all information for a user.

Description

  • u - The user name for whom information will be displayed \\n NOTE: If user name contains '\' escape charater , the input needs to be escaped properly, for example if user name is like "Domain\User" then the input needs to be "Domain\\User"
  • id - The user id for whom information will be displayed

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:show_user xmlns:nas="http://opsware.com/nas/">

      <nas:sessionid xsi:type="xsd:string">session id from login</nas:sessionid>

      <!-- Optional arguments -->

      <nas:id xsi:type="xsd:string">id</nas:id>

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

    </nas:show_user>

  </SOAP-ENV:Body>

</SOAP-ENV:Envelope>


show_version

Description

Display the release version of NA.

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:show_version xmlns:nas="http://opsware.com/nas/">

      <nas:sessionid xsi:type="xsd:string">session id from login</nas:sessionid>

    </nas:show_version>

  </SOAP-ENV:Body>

</SOAP-ENV:Envelope>


stop_task

Stop a running task.

Description

  • id - The task ID of the task to stop.

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:stop_task xmlns:nas="http://opsware.com/nas/">

      <nas:sessionid xsi:type="xsd:string">session id from login</nas:sessionid>

      <nas:id xsi:type="xsd:string">id</nas:id>

    </nas:stop_task>

  </SOAP-ENV:Body>

</SOAP-ENV:Envelope>


stop_task_all

Stop all Running and Waiting tasks.

Description

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:stop_task_all xmlns:nas="http://opsware.com/nas/">

      <nas:sessionid xsi:type="xsd:string">session id from login</nas:sessionid>

    </nas:stop_task_all>

  </SOAP-ENV:Body>

</SOAP-ENV:Envelope>


synchronize

Synchronize a device's startup and running configs.

Description

Synchronize a device's startup configuration so it matches its running configuration. The synchronize 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)
  • skipinsync - Indicates that the command should skip any device that the system indicates already has matching startup and running configs.
  • 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 synchronize task is complete. Do not use this option with -start.
  • comment - An optional comment about the synchronize task.

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:synchronize xmlns:nas="http://opsware.com/nas/">

      <nas:sessionid xsi:type="xsd:string">session id from login</nas:sessionid>

      <!-- Optional arguments -->

      <nas:comment xsi:type="xsd:string">comment</nas:comment>

      <nas:group xsi:type="xsd:string">device group</nas:group>

      <nas:ip xsi:type="xsd:string">ipaddress</nas:ip>

      <!-- Note: host or fqdn can be sent instead of ip -->

      <nas:rep xsi:type="xsd:string">repeat</nas:rep>

      <nas:skipinsync xsi:type="xsd:string">skip if device already in sync</nas:skipinsync>

      <nas:start xsi:type="xsd:string">YYYY:MM:DD:HH:mm</nas:start>

      <nas:sync xsi:type="xsd:string">execute synchronously?</nas:sync>

    </nas:synchronize>

  </SOAP-ENV:Body>

</SOAP-ENV:Envelope>


test_config

Test policy compliance for a device configuration script.

Description

This command is used to verify whether a configuration script is in compliance with applicable policies.

  • family - The device family for the configuration script to be tested("Cisco IOS", F5, etc.)
  • script - The configuration script to be tested.
  • policy - The name of the policy for which the script will be test against.
  • group - Specify a device group name. The test will be performed against the policies that are applicable to the group. If both -policy and -group are used, -group argument will be ignored. If none of -policy and -group is used, test will be performed against all applicable policies.

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:test_config xmlns:nas="http://opsware.com/nas/">

      <nas:sessionid xsi:type="xsd:string">session id from login</nas:sessionid>

      <nas:family xsi:type="xsd:string">device family name</nas:family>

      <nas:script xsi:type="xsd:string">configuration text</nas:script>

      <!-- Optional arguments -->

      <nas:group xsi:type="xsd:string">device group name</nas:group>

      <nas:policy xsi:type="xsd:string">policy name</nas:policy>

    </nas:test_config>

  </SOAP-ENV:Body>

</SOAP-ENV:Envelope>


test_software

Test software levels for a device or device group.

Description

  • ip - The IP address of a single device to test.
  • group - A device group containing multiple devices to test.

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:test_software xmlns:nas="http://opsware.com/nas/">

      <nas:sessionid xsi:type="xsd:string">session id from login</nas:sessionid>

      <!-- Optional arguments -->

      <nas:group xsi:type="xsd:string">group</nas:group>

      <nas:ip xsi:type="xsd:string">ipaddress</nas:ip>

      <!-- Note: host or fqdn can be sent instead of ip -->

    </nas:test_software>

  </SOAP-ENV:Body>

</SOAP-ENV:Envelope>


test_view

Description

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:test_view xmlns:nas="http://opsware.com/nas/">

      <nas:sessionid xsi:type="xsd:string">session id from login</nas:sessionid>

      <nas:name xsi:type="xsd:string">viewName</nas:name>

    </nas:test_view>

  </SOAP-ENV:Body>

</SOAP-ENV:Envelope>


traceroute

Run a traceroute command on a device.

Description

Causes a series of traceroute commands to be executed on a device. One traceroute 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, 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 traceroute 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 traceroute 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


<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:traceroute xmlns:nas="http://opsware.com/nas/">

      <nas:sessionid xsi:type="xsd:string">session id from login</nas:sessionid>

      <nas:dest xsi:type="xsd:string">target IP addresses</nas:dest>

      <!-- Optional arguments -->

      <nas:async xsi:type="xsd:string">execute synchronously?</nas:async>

      <nas:rep xsi:type="xsd:string">repeat</nas:rep>

      <nas:source xsi:type="xsd:string">ipaddress</nas:source>

      <nas:sourcegroup xsi:type="xsd:string">source group</nas:sourcegroup>

      <nas:start xsi:type="xsd:string">YYYY:MM:DD:HH:mm</nas:start>

    </nas:traceroute>

  </SOAP-ENV:Body>

</SOAP-ENV:Envelope>


undeploy_image

undeploy software images from device

Description

delete software images from device.

  • ip - ip address of the device the images will be deleted.
  • images - images to be deleted.
  • reboot - wheather to reboot the device after deleting images.
  • rebootwait - seconds to wait before reboot.
  • filesystem - name of filesystem of the device the images will be deleted.
  • pretask - name of task before delete.
  • posttask - name of task after delete.
  • 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


<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:undeploy_image xmlns:nas="http://opsware.com/nas/">

      <nas:sessionid xsi:type="xsd:string">session id from login</nas:sessionid>

      <nas:images xsi:type="xsd:string">name</nas:images>

      <nas:ip xsi:type="xsd:string">ip</nas:ip>

      <!-- Note: host or fqdn can be sent instead of ip -->

      <!-- Optional arguments -->

      <nas:filesystem xsi:type="xsd:string">fs</nas:filesystem>

      <nas:posttask xsi:type="xsd:string">posttask</nas:posttask>

      <nas:pretask xsi:type="xsd:string">pretask</nas:pretask>

      <nas:reboot xsi:type="xsd:string">reboot</nas:reboot>

      <nas:rebootwait xsi:type="xsd:string">0</nas:rebootwait>

      <nas:sessionlog xsi:type="xsd:string">(true|false)</nas:sessionlog>

    </nas:undeploy_image>

  </SOAP-ENV:Body>

</SOAP-ENV:Envelope>


update_dynamic_group

Update dynamic group's member devices.

Description

Recalculate a dynamic group's member devices based on the predefined criteria. This has no effect on a non-dynamic device group.

  • name - The group name for which the member devices will be updated

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:update_dynamic_group xmlns:nas="http://opsware.com/nas/">

      <nas:sessionid xsi:type="xsd:string">session id from login</nas:sessionid>

      <nas:name xsi:type="xsd:string">current group name</nas:name>

    </nas:update_dynamic_group>

  </SOAP-ENV:Body>

</SOAP-ENV:Envelope>


Login Response

Response to the login request.

Description

A successful login request generates a loginreply response with a sessionid. The session id is included in all other CWNCM SOAP API requests.

If multiple requests are included in one SOAP Body, then multiple responses are included in the response. When an error occurs CWNCM stops processing requests unless the SOAP Header Attribute ContinueOnError is set.

Example


<?xml version="1.0" encoding="UTF-8"?>

<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:loginreply xmlns:nas="http://opsware.com/nas/"> 

      <nas:sessionid xsi:type="xsd:string">s027283733873</nas:sessionid>

    </nas:loginreply> 

  </SOAP-ENV:Body>

</SOAP-ENV:Envelope>


Text Response

Response to commands that return a single block of text.

Description

Commands that return a single block of text, such as show config, generate a Result response with a Status string and a Text block.

Example


<?xml version="1.0" encoding="UTF-8"?>

<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:Result xmlns:nas="http://opsware.com/nas/"> 

      <nas:Status xsi:type="xsd:string">200 OK</nas:Status>

      <nas:Text xsi:type="xsd:string">Text Block

goes here.

Can be multiple

lines.</nas:Text>

    </nas:Result> 

  </SOAP-ENV:Body>

</SOAP-ENV:Envelope>


Result Set Response

Response to commands that return a set of results.

Description

Commands that return a set of results, such as list device, generate a Result response with a Status string and a ResultSet.

If the SOAP Header Attribute DropNullElements is set then null elements in the ResultSet will not be included.

For details on the return types and result set values, see the CWNCM Java API Guide (PDF).

Example


<?xml version="1.0" encoding="UTF-8"?>

<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:Result xmlns:nas="http://opsware.com/nas/"> 

      <nas:Status xsi:type="xsd:string">200 OK</nas:Status>

      <nas:ResultSet>

        <nas:Row>

          <nas:deviceID xsi:type="xsd:string">383</nas:deviceID>

          <nas:hostName xsi:type="xsd:string">la-border2</nas:hostName>

          <nas:primaryIPAddress xsi:type="xsd:string">10.255.30.4</nas:primaryIPAddress>

          ...

        </nas:Row>

        ...

      </nas:ResultSet>

    </nas:Result> 

  </SOAP-ENV:Body>

</SOAP-ENV:Envelope>


Using the WSDL file

As part of the installation, there are files named api.wsdl.* in the client/sdk/ directory of the core and client installations. These files represent each of the toolsets against which some amount of testing was performed. These toolsets can be stub compilers or other toolsets that can import WSDL files. can be used by a stub compiler or other toolset that can import a WSDL file. The following information describes specific toolsets and any known issues you might encounter.

As with any WSDL file, the endpoint is specified in the <service> element. The value of the endpoint will be set to 'localhost' by default. This should be changed if it poses a problem for the target environment.

gSOAP - c/c++ stub compiler

For this toolset, use the api.wsdl.gsoap file.

When using the wsdl2h tool, there is a long list of warnings related to the use of a "type" versus an "element" in the types section. These warnings are benign. Normally, when using this tool, you use the generated .nsmap file. This structure contains URIs that do not work well with the server side implementation. As a workaround, use something similar to the following in the program:




SOAP_NMAC struct Namespace namespaces[] =

{

	{"SOAP-ENV", "http://schemas.xmlsoap.org/soap/envelope/", NULL, NULL},

	{"SOAP-ENC", "http://www.w3.org/2003/05/soap-encoding", "http://www.w3.org/*/soap-encoding", NULL},

	{"xsi", "http://www.w3.org/2001/XMLSchema-instance", "http://www.w3.org/*/XMLSchema-instance", NULL},

	{"xsd", "http://www.w3.org/2001/XMLSchema", "http://www.w3.org/*/XMLSchema", NULL},

	{"wsdl", "http://tempuri.org/wsdl.xsd", NULL, NULL},

	{"nas", "http://opsware.com/nas/", NULL, NULL},

	{NULL, NULL, NULL, NULL}

};

axis1.4 and wsdl2java - Apache axis stub compiler for java

For this toolset, use the api.wsdl.axis file.

Java has a hard limit of 256 parameters to a method. This tool generates constructors for each of the objects it finds in the WSDL file. One of these objects, Row, contains more than 256 members. As a result, one of the generated constructors has too many arguments. This can be solved in your make or ant environment by doing a deletion or replacement, for example:


	sed -i -e '/public Row($$/, /}/d' $OUT_CLASS_DIR/Row.java

axis2 and wsdl2java - Apache axis2 stub compiler for java

For this toolset, use the api.wsdl.axis2 file.

The constructor problem described in the previous section does not apply to this tool for client-side generated code.

The generated stub, which will be located at:


src/com/opsware/nas/_72/NetworkManagementApiStub.java

must be modified to work properly against the service to avoid the runtime exception regarding an incorrect subelement Result. A command like the following can be used to remedy this problem prior to compiling the stubs to class files:

sed -i -e 's/QName(""/QName("http:\/\/opsware.com\/nas\/72"/g' src/com/opsware/nas/_72/NetworkManagementApiStub.java

wsdl2py - Python stub compiler from the ZSI package

For this toolset, use the api.wsdl.wsdl2py file.

Once the stubs are created, there is a change which must be made to the resulting files. One of the exported functions is called "import". Since this is a reserved word in Python, using import creates a conflict. The Python stub compiler creates a method for each of the exposed methods of the service. For this module to compile, you must rename this method. As part of the build process, doing a simple replacement in the stub file after it is generated solves the problem:


    sed -i -e 's/def import/def _import/g' `grep -l "def import" * | grep -v Makefile `

The reason for the embeded grep is because different versions of ZSI will generate different stub names.

SOAPpy - Python module

For this toolset, use the api.wsdl.soappy file.

This module allows the dynamic loading of a file, rather than creation of stubs like other tools. One way to make usage easier is making sure the endpoint in the <service> tag points to the desired CWNCM server before using the file to create the WSDL.Proxy object. By default, this file comes with an endpoint of localhost. It may be easier to modify the file that this tool uses rather than changing the endpoint explicitly when using this toolset.

.NET wsdl.exe compiler

For this toolset, use the api.wsdl.dotnet file.

There are compabibility issues with Visual Studio .NET 2003. At this time, only wsdl.exe from Visual Studio .NET 2005 is supported. If use with VS 2003 is requried, generating stubs in VS 2005 and using 2003 should solve the issue.

wsdl.exe does not create custom exceptions based on the <fault> information in the WSDL. To handle exceptions thrown by the server, something like the following will be required in the program:


            try

            {

    			result = api.login( inParms );

            }

            catch( System.Web.Services.Protocols.SoapException e )

            {

                Console.WriteLine( "Caught exception: " + e.Message );

                //  e.Detail contains the parsable node

            }