SOAP API Reference for Network Compliance Manager 1.3

Document Version 1.3_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, refer to the section Using the WSDL file at the end in this document.

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 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_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

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

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

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 snmp supportes, use -action snmp
• 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

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>

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

      <!-- Optional arguments -->

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

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

      <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

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