HP Network Automation Software (NA) CLI/API Command Reference

Software Version: 10.11

Document Release Date: November 2015
Software Release Date: November 2015


New Commands in NA 10.11 Revised Commands in NA 10.11
None
  • add event rule (help content only)
  • assign auto remediation script (help content only)
  • check policy compliance (help content only)
  • create policy (help content only)
  • create policy rule (help content only)
  • create rule condition (help content only)
  • create rule exception (help content only)
  • delete policy (help content only)
  • delete policy rule (help content only)
  • delete rule condition (help content only)
  • delete rule exception (help content only)
  • export policy (help content only)
  • import policy (help content only)
  • list event (help content only)
  • list policies (help content only)
  • list policy id (help content only)
  • list policy rule (help content only)
  • list task (help content only)
  • mod partition
  • mod policy (help content only)
  • mod policy rule (help content only)
  • mod rule condition (help content only)
  • remove auto remediation script (help content only)
  • run diagnostic (help content only)
  • set policy rule logic (help content only)
  • show event (help content only)
  • show policy (help content only)
  • show policy compliance (help content only)
  • show policy rule (help content only)
  • show task (help content only)

Command comparison is relative to NA 10.10.

Contents

NOTE: Return type of STATUS means that the command returns no Text or ResultSet. Use getReturnStatus() to determine the command results.

NOTE: The Perl API does not exactly match the NA command-line interface documented here. For information about the differences, see “Perl Documentation” in the NA API User Guide.

acquire resource id

Acquire a resource identity from a resource identity pool.

Synopsis

acquire resource id [-poolid <Resource identity pool ID>] [-name <Name>] [-id <ID>]

Description

Acquire a resource identity from a resource identity pool. If resource identity ID or name is not provided, the next available resource identity in a pool identified by a pool ID is acquired. Resource identity can be identified either by ID or combination of name and resource identity pool ID. If resource identity ID is specified, name and resource pool ID are ignored.

Return Type

VO:ResourceIdentityVO with columns:

Examples

Contents


activate device

Mark a device as activated.

Synopsis

activate device [-ip <IP address>] [-host <Hostname>] [-fqdn <Fully Qualified Domain Name>] [-deviceid <Device ID>]

Description

Return Type

STATUS

Examples

Contents


add advanced diagnostic

Add a new advanced diagnostic.

Synopsis

add advanced diagnostic -name <Name> [-description <Description>] [-family <Device Family>] -language <Script Language> [-parameters <Parameters>] -script <Script Text> [-sitename <Site name>]

Description

Return Type

STATUS

Examples

Contents


add advanced script

Add a new advanced script.

Synopsis

add advanced script -name <Name> [-description <Description>] [-scripttype <Script Type>] [-family <Device Family>] -language <Script Language> [-parameters <Parameters>] -script <Script Text> [-sitename <Site name>]

Description

Return Type

STATUS

Examples

Contents


add authentication

Add device password information.

Synopsis

add authentication -loc <Location> [-ip <IP address>] [-host <Hostname>] [-fqdn <Fully Qualified Domain Name>] [-deviceid <Device ID>] [-snmpro <Read only community string(s)>] [-snmprw <Read write community string(s)>] [-snmpv3user <SNMPv3 Username>] [-snmpv3authpw <SNMPv3 Authentication Password>] [-snmpv3encryptpw <SNMPv3 Encryption Password>] [-user <Username>] [-passwd <Password>] [-enablepasswd <Enable password>] [-connectionmethods <Connection methods>] [-accessvariables <Access variables>] [-start <Task start date>] [-appendsnmpro] [-appendsnmprw] [-sync] [-group <Group name>] [-site <SiteName>] [-rule <Rule name>] [-rulehostname <Rule hostname>] [-ruledevicegroup <Rule device group>] [-iprangestart <Rule ip start range>] [-iprangeend <Rule ip end range>] [-taskname <Task Name>]

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.

Return Type

String

Examples

Contents


add command script

Add a new command script.

Synopsis

add command script -name <Name> [-description <Description>] [-scripttype <Script Type>] -mode <Mode> [-driver <Driver List>] -script <Script Text> [-sitename <Site name>]

Description

Return Type

STATUS

Examples

Contents


add device

Add a device to the system.

Synopsis

add device -ip <IP address> [-hostname <Host name>] [-comment <Comment>] [-description <Device name>] [-model <Device model>] [-vendor <Device vendor>] [-domain <Domain name>] [-serial <Serial number>] [-asset <Asset tag>] [-location <Location>] [-status <Status>] [-nopoll <Do not poll>] [-consoleip <Console IP address, if using console server>] [-consoleport <Console Port>] [-tftpserverip <TFTP server IP address, if using NAT>] [-natip <NAT IP address>] [-useconsoleserver <true or false>] [-accessmethods <Comma-separated list of access methods>] [-hierarchylayer <Hierarchy layer>] [-origin <Device Origin>] [-forcesave <true or false>]

Description

Return Type

Integer

Examples

Contents


add device context

Add Device Context

Synopsis

add device context -deviceid <Device ID> -contextvariables <Context Variables> [-taskname <Task name>]

Description

For drivers that support it, add a virtual context to a device

Return Type

VO:ScheduleTaskVO with columns:

Examples

Contents


add device group

Add a device group to the system.

Synopsis

add device group -name <Name> [-type <Type>] [-comment <Comment>] [-shared <Shared>] [-criteria <Criteria>] [-searchgroups <Searchgroups>] [-limitsearchgroups <Limitsearchgroups>] [-partitions <Partitions>]

Description

Return Type

STATUS

Examples

Contents


add device relationship

Add a new Device relationship between two devices.

Synopsis

add device relationship -origindeviceid <Originating Device ID> -destdeviceid <Destination Device ID> -relationshiptypeid <Relationship Type ID>

Description

Adds a new device relationship between the two given devices.

Return Type

VO:DeviceRelationshipVO with columns:

Examples

Contents


add device template

Add a new device template.

Synopsis

add device template -hostname <Device name> [-driver <Driver name>] [-comment <Comment>] [-description <Description>] [-model <Device model>] [-vendor <Device vendor>] [-location <Location>] [-customname <Custom data column name>] [-customvalue <Custom data value>] [-customnames <Custom data column names>] [-customvalues <Custom data values>] [-accessmethods <Comma-separated list of access methods>] [-hierarchylayer <Hierarchy layer>] [-sitename <Site Name>]

Description

Return Type

STATUS

Examples

Contents


add device to group

Add a device to a device group.

Synopsis

add device to group [-ip <IP address>] [-host <Hostname>] [-fqdn <Fully Qualified Domain Name>] [-deviceid <Device ID>] -group <Device group>

Description

Return Type

STATUS

Examples

Contents


add diagnostic

Add a new custom diagnostic script.

Synopsis

add diagnostic -name <Name> [-description <Description>] -mode <Mode> [-driver <Driver List>] -script <Script Text> [-sitename <Site name>]

Description

Return Type

STATUS

Examples

Contents


add event

Add an event.

Synopsis

add event -message <Event> [-ip <IP address>] [-host <Hostname>] [-fqdn <Fully Qualified Domain Name>]

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.

Return Type

STATUS

Examples

Contents


add event rule

Add an event rule. However, with the HP Network Automation Software Premium edition license, you cannot add rules for the occurrence of the following events:

Synopsis

add event rule -name <Event Rule Name> -action <Event Action> [-receiverhost <Hostname or IP Address>] [-receiverport <Port>] [-events <List of Event Types>] [-community <Community String>] [-eventtemplate <Event Template Filename>] [-eventtext <Event Text>] [-site <Site Name>]

Description

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

Return Type

STATUS

Examples

Contents


add group

Add a group to the system.

Synopsis

add group -name <Name> -type <Type> [-comment <Comment>] [-shared <Shared>]

Description

Return Type

STATUS

Examples

Contents


add group to parent group

Add a device group to a parent device group.

Synopsis

add group to parent group -parent <Parent group name> -child <Child group name>

Description

Return Type

STATUS

Examples

Contents


add image

Add images to database.

Synopsis

add image [-site <site name>] -imageset <imageset name> -images <images> [-driver <driver name>] [-model <model name>] [-memory <minimum system memory (in bytes)>] [-processor <processor name>] [-bootrom <BootROM name>]

Description

Add images to database. Must specify either driver or model

Return Type

STATUS

Examples

Contents


add imageoption

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

Synopsis

add imageoption [-imagemodels <device model names (separeted by ',')>] [-imageprocessors <device processor names (separeted by ','),>] [-imagebootroms <device bootROM names (separeted by ','),>]

Description

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

Return Type

STATUS

Examples

Contents


add ip

Add new secondary ip.

Synopsis

add ip -ipvalue <Value> [-deviceip <Device IP address>] [-comment <Comment>] [-usetoaccess <Use to Access Device>] [-ip <IP address>] [-host <Hostname>] [-fqdn <Fully Qualified Domain Name>] [-deviceid <Device ID>]

Description

Return Type

STATUS

Examples

Contents


add metadata

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

Synopsis

add metadata -fieldid <Metadata Field ID> [-data <Data>] -associatedtableid <Matching Row ID>

Description

Return Type

MetadataVO with columns:

Examples

Contents


add metadata field

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

Synopsis

add metadata field -fieldname <Field Name> [-fieldvalues <Field Values>] [-inuse <In Use>] [-flags <Allow HTML>] -associatedtable <Associated Table>

Description

Return Type

MetadataFieldVO with columns:

Examples

Contents


add parent group

Add a parent group to the system.

Synopsis

add parent group -name <Name> -type <Type> [-comment <Comment>]

Description

Return Type

STATUS

Examples

Contents


add partition

Add a partition to view.

Synopsis

add partition -viewname <Viewname> -name <Name> [-comment <Comment>]

Description

Return Type

STATUS

Examples

Contents


add resource id

Add a resource identity to a resource identity pool.

Synopsis

add resource id -name <Name> -poolid <Resource identity pool ID> [-description <Description>] -status <Status>

Description

Add a resource identity to a resource identity pool.

Return Type

VO:ResourceIdentityVO with columns:

Examples

Contents


add resource id pool

Create a resource identity pool associated with a given site.

Synopsis

add resource id pool -name <Name> [-description <Description>] [-site <Site Name>]

Description

Create a resource identity pool associated with a given site.

Return Type

VO:ResourceIdentityPoolVO with columns:

Examples

Contents


add role

Create a user role of type modify device partition or view partition permission.

Synopsis

add role -name <Role name> -type <Role type> -resources <Resources> [-viewname <Device view name>] [-desc <Description>]

Description

Create a user role.

Return Type

STATUS

Examples

Contents


add service type

Adds a custom service type to a device

Synopsis

add service type [-ip <IP Address>] [-deviceid <Device ID>] -service <Service Name>

Description

Adds a custom service type to a device.

Return Type

STATUS

Examples

Contents


add system message

Add a system message.

Synopsis

add system message -message <System Message> [-ip <IP address>] [-host <Hostname>] [-fqdn <Fully Qualified Domain Name>] [-deviceid <Device ID>]

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.

Return Type

STATUS

Examples

Contents


add user

Add a user to the system.

Synopsis

add user -u <Username> -p <Password> -fn <First name> -ln <Last name> [-email <Email address>] [-aaausername <Username>] [-aaapassword <AAA Password>] [-useaaaloginforproxy <Use AAA Logins for Proxy (yes|no)>] [-extauthfailover <Allow External Auth Failover (yes|no)>]

Description

Return Type

STATUS

Examples

Contents


add user to group

Add a user to a user group.

Synopsis

add user to group -u <Username> -g <User group name>

Description

Return Type

STATUS

Examples

Contents


add vlan

Adds a Vlan - Add ports

Synopsis

add vlan [-deviceid <Device IP address>] [-ip <IP address>] [-host <Hostname>] [-fqdn <Fully Qualified Domain Name>] [-deviceid <Device ID>] -vlanid <Vlan ID> [-vlanname <Vlan Name>] [-addports <Add Port IDs>] [-start <Task start date>] [-rep <Task repeat period>] [-sync] [-sessionlog <true or false>] [-retrycount <Retry count>] [-retryinterval <Retry interval>] [-comment <Snapshop comment>] [-presnapshot <true or false>] [-postsnapshot <true, false or task>] [-priority <Task priority>] [-taskname <Task name>]

Description

Return Type

String

Examples

Contents


add vlan trunk

Adds a Vlan trunk - Add vlans to the trunk

Synopsis

add vlan trunk [-deviceip <Device IP address>] [-ip <IP address>] [-host <Hostname>] [-fqdn <Fully Qualified Domain Name>] [-deviceid <Device ID>] -portname <Port Name> [-nativevlanid <Native vlan ID>] -addvlanids <Add Vlan IDs> [-start <Task start date>] [-rep <Task repeat period>] [-sync] [-sessionlog <true or false>] [-retrycount <Retry count>] [-retryinterval <Retry interval>] [-comment <Snapshop comment>] [-presnapshot <true or false>] [-postsnapshot <true, false or task>] [-priority <Task priority>] [-taskname <Task name>]

Description

Return Type

String

Examples

Contents


annotate access

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

Synopsis

annotate access -id <Device access record ID> [-comment <Comment>] [-name <Name>] [-customname <Custom data column name>] [-customvalue <Custom data value>] [-customnames <Custom data column names>] [-customvalues <Custom data values>]

Description

Return Type

STATUS

Examples

Contents


annotate config

Add a comment to the specified config.

Synopsis

annotate config -id <Config ID> -comment <comment>

Description

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

Return Type

STATUS

Examples

Contents


assign auto remediation script

Assign an auto-remediation script. This command is available only with the HP Network Automation Software Ultimate edition license.

Synopsis

assign auto remediation script -ruleid <Policy Rule ID> -scriptid <Custom Script ID>

Description

It lets users assign an existing command script to a policy rule. Any command script in the system can be assigned as long as they comply the syntax of auto-remediation scripting language and rule definition.

Return Type

STATUS

Examples

Contents


assign driver

Manually assign driver to device.

Synopsis

assign driver [-ip <IP address>] [-id <Device ID>] -name <Driver Name>

Description

Return Type

STATUS

Examples

Contents


check policy compliance

Schedules Check Policy Compliance task. This command is available only with the HP Network Automation Software Ultimate edition license.

Synopsis

check policy compliance [-ip <Device IP>] [-group <Device Group>] -types <Rule Types> [-start <Task Start Date>] [-rep <Repetition Interval>] [-sync] [-runmode <Run Mode>] [-stoponfailure <Stop on Failure>] [-sessionlog <true or false>] [-retryCount <Retry Count>] [-retryInterval <Retry Interval>] [-comment <Comment>] [-priority <Task priority>] [-taskname <Task name>]

Description

It schedules a check policy compliance task. Note that: Either a device identified by IP (-ip option) or a device group identified by name (-group option) must be provided, and the task will be scheduled for a device or a group of devices. -types option is mandatory and determines what types of policy rules will be checked. Multiple types must be separated by commas. For example: -types "config,level". The options are: 'config', 'diagnostic', 'software', 'level' (for software level)

Return Type

String

Examples

Contents


configure syslog

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

Synopsis

configure syslog [-ip <IP address>] [-group <Groupname>] [-host <Hostname>] [-fqdn <Fully Qualified Domain Name>] [-deviceid <Device ID>] [-rep <Task repeat period>] [-sync] [-runmode <Run Mode>] [-stoponfailure <Stop on Failure>] [-start <Task start date>] [-comment <Snapshop comment>] [-usesyslogrelay <IP address>] [-priority <Task priority>] [-taskname <Task name>]

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.

Return Type

String

Examples

Contents


connect

Connect to a device.

Synopsis

connect [-login] [-method <telnet|ssh|ssh1|ssh2|rlogin>] [-override] [-info] [-ignoreptyerrors] []

Description

Connect to a device through the system's Proxy Interface via telnet, ssh, or rlogin. If you are connected to a device through a console server, you may hit ctrl-\ to return to the the system shell after logging out of the device.

Return Type

None

Examples

Contents


create policy

Create a policy. This command is available only with the HP Network Automation Software Ultimate edition license.

Synopsis

create policy -name <Policy Name> [-site <Site Name>] [-tag <Policy Tag>] [-desc <Policy Description>] [-dg <Policy Scope>] [-exceptions <Policy Exceptions>] [-status <Policy Status (active|inactive)>] [-cve <CVE>] [-aurl <Vendor Advisory URL>] [-surl <Vendor Solution URL>] [-ddate <Disclosure Date>] [-solution <Solution>]

Description

All the fields on the policy page UI can be passed to the API call. Note that the '-dg' option can take multiple device groups to set the scope of the policy to be created. Device group names must be separated by commas. The '-exceptions' option can take multiple devices by either IP addresses or host names separated by commas. Default value -status option is inactive, therefore, a policy created without -status active will be created as inactive. Created policy will not have any rules in it. create policy rule CLI command or API call must be used to create rule(s) after a policy is created.

Return Type

ConfigPolicyVO with columns:

Examples

Contents


create policy rule

Create a policy rule. This command is available only with the HP Network Automation Software Ultimate edition license.

Synopsis

create policy rule -policyid <Policy ID> -name <Policy Rule Name> -type <Policy Rule Type (configuration|diagnistic|software)> -devicefamily <Device Family (type 'all' to apply to all device families)> [-drivers <Drivers (comma separated internal names of drivers)>] [-importance <Importance (informationa|low|medium|high|critical)>] [-useblock <Define Block Start/End Patterns (true|false)>] [-textblockstartpattern <Text Block Start Regex Pattern, or null to remove existing>] [-textblockendpattern <Text Block End Regex Pattern, or null to remove existing>] [-desc <Rule Description>] [-details <Detailed Description>]

Description

Note that: To apply to all device families, please use '-devicefamily all' option. Device family name is the internal name. If the name provided is not valid, the command will fail and print valid device family names as reference. If user has only provided the device family name ('-devicefamily' option) but not drivers with '-drivers' option, it will be assumed to be all device drivers. If one or more drivers are provided with '-drivers' option, the scope will be set accordingly. Driver names are internal names in NA. If there is one or more invalid driver names provided, the command will fail and print all valid driver names under the given device family. There is a separate command to create exceptions ('create rule exception' command). Auto-remediation scripts can be assigned to a rule using 'assign auto remediation script' command. The rule created will not have any rule conditions in it, and the boolean expression (rule logic) will be empty. There are other commands to create rule conditions and set the rule logic.

Return Type

ConfigRuleVO with columns:

Examples

Contents


create rule condition

Synopsis

create rule condition -ruleid <Policy Rule ID> -label <Label (A letter A-Z)> -datamodel <Data Model Element Name> -operator <Operator Name> -operand <Operand (text or regex pattern)> [-exceptionoperand <Except Operand (Second operand, for 'must contain only' operator>] [-regex <Regex (true|false)>] [-exactorder <Exact Order (true|false)>]

Description

Note that: Data model element name provided by '-datamodel' option is the internal name. The list of data model names will be printed if the name provided is not valid. The operator name is also internal name. The list of valid operator names for a given data model element will be printed if the operator name provided is not valid. If the the operator is 'must contain only', the '-exceptionoperand' must be provided. Creating a rule condition will not update the rule logic. User must use 'set rule logic' command to update the rule logic boolean expression accordingly.

Return Type

RuleConditionVO with columns:

Examples

Contents


create rule exception

Create a policy rule exception. This command is available only with the HP Network Automation Software Ultimate edition license.

Synopsis

create rule exception -ruleid <Policy Rule ID> -device <Device ID, IP or Host Name> [-expirationdate <Expiration Date>] [-pattern <Pattern (regular expression)>]

Description

Note that: If regular expression pattern is not provided ('-pattern' option), the device will be excluded completely; otherwise, only the config text matching the pattern will be excluded. If an expiration date is not provided ('-expirationdate' option), the exception will never expire.

Return Type

ConfigExceptionVO with columns:

Examples

Contents


crypto

Use the system encryption method to encrypt a string value.

Synopsis

crypto -encrypt <String value>

Description

Result is the encrypted string.

Return Type

String

Examples

Contents


deactivate device

Mark a device as deactivated.

Synopsis

deactivate device [-ip <IP address>] [-host <Hostname>] [-fqdn <Fully Qualified Domain Name>] [-deviceid <Device ID>]

Description

Return Type

STATUS

Examples

Contents


del access

Delete access records.

Synopsis

del access [-id <Device Access Record ID.>] [-cutoff <Date>]

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.

Return Type

STATUS

Examples

Contents


del authentication

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

Synopsis

del authentication [-ip <IP address>] [-host <Hostname>] [-fqdn <Fully Qualified Domain Name>] [-deviceid <Device ID>] [-loc <Location>] [-site <Site Partition>] [-rulename <Rule Name>]

Description

Return Type

STATUS

Examples

Contents


del cache

Delete cached information from a region.

Synopsis

del cache -region <REGION_NAME>

Description

Delete information from a region in the cache.

Return Type

None

Examples

Contents


del device

Delete the specified device.

Synopsis

del device [-ip <IP address>] [-host <Hostname>] [-fqdn <Fully Qualified Domain Name>] [-deviceid <Device ID>]

Description

Return Type

STATUS

Examples

Contents


del device context

Delete A Device Context

Synopsis

del device context -deviceid <Device ID> -contextvariables <Context Variables> [-taskname <Task name>]

Description

For drivers that support it, remove a virtual context from a device

Return Type

String

Examples

Contents


del device data

Delete device configuration and diagnostic data.

Synopsis

del device data [-id <Config ID>] [-cutoff <Date>]

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

Return Type

STATUS

Examples

Contents


del device from group

Delete a device from a device group.

Synopsis

del device from group [-ip <IP address>] [-host <Hostname>] [-fqdn <Fully Qualified Domain Name>] [-deviceid <Device ID>] -group <Device group>

Description

Return Type

STATUS

Examples

Contents


del device relationship

Delete the relationship identified by the relationship id

Synopsis

del device relationship -relationshipid <Relationship ID>

Description

Delete the relationship identified by the relationship id

Return Type

String

Examples

Contents


del device template

Delete the specified device template.

Synopsis

del device template -templateid <Device template ID>

Description

Return Type

STATUS

Examples

Contents


del drivers

Delete all drivers associated with a device.

Synopsis

del drivers [-ip <IP address>] [-host <Hostname>] [-fqdn <Fully Qualified Domain Name>] [-deviceid <Device ID>]

Description

Return Type

STATUS

Examples

Contents


del event

Delete the specified event.

Synopsis

del event -id <event ID>

Description

Return Type

STATUS

Examples

Contents


del group

Delete a group from the system.

Synopsis

del group [-name <Name>] [-id <Group ID>] -type <Type> [-force]

Description

Specify the group by both its type and name or ID.

Return Type

STATUS

Examples

Contents


del group from parent group

Remove a device group from a parent device group.

Synopsis

del group from parent group -parent <Parent group name> -child <Child group name>

Description

Return Type

STATUS

Examples

Contents


del ip

Delete the specified ip.

Synopsis

del ip -ipvalue <Value> [-deviceip <Device IP address>] [-ip <IP address>] [-host <Hostname>] [-fqdn <Fully Qualified Domain Name>] [-deviceid <Device ID>]

Description

Return Type

STATUS

Examples

Contents


del metadata

Delete a specific piece of custom data.

Synopsis

del metadata -metadataid <Metadata ID>

Description

Return Type

STATUS

Examples

Contents


del metadata field

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

Synopsis

del metadata field -fieldid <Field ID>

Description

Return Type

STATUS

Examples

Contents


del partition

Delete a partition from view.

Synopsis

del partition -name <Name>

Description

Return Type

STATUS

Examples

Contents


del resource id

Delete a resource identity from a resource identity pool.

Synopsis

del resource id -id <ID>

Description

Delete a resource identity from a resource identity pool.

Return Type

null

Examples

Contents


del resource id pool

Delete a resource identity pool.

Synopsis

del resource id pool -id <ID>

Description

Delete a resource identity pool.

Return Type

null

Examples

Contents


del role

Delete a user role of any type.

Synopsis

del role -name <Role name>

Description

Delete a user role of any type.

Return Type

STATUS

Examples

Contents


del script

Delete an existing command script, advanced script or diagnostic.

Synopsis

del script [-id <Script / Diagnostic ID>] [-name <Script / Diagnostic Name>] [-type <Script / Diagnostic Type>]

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.

Return Type

STATUS

Examples

Contents


del service type

Remove a service type from a device

Synopsis

del service type [-ip <IP Address>] [-deviceid <Device ID>]

Description

Removes all service types from a device.

Return Type

STATUS

Examples

Contents


del session

Delete an interceptor log record.

Synopsis

del session -id <Interceptor log id>

Description

Return Type

STATUS

Examples

Contents


del system message

Delete the specified system message.

Synopsis

del system message -id <System message ID>

Description

Return Type

STATUS

Examples

Contents


del task

Delete a task.

Synopsis

del task -id <Task ID>

Description

Deletes a task, whether it has run or not.

Return Type

STATUS

Examples

Contents


del user

Delete a user from the system.

Synopsis

del user -u <User name>

Description

Return Type

STATUS

Examples

Contents


del user from group

Delete a user from a user group.

Synopsis

del user from group -u <Username> -g <User group name>

Description

Return Type

STATUS

Examples

Contents


del vlan

Delete a Vlan given a VlanID

Synopsis

del vlan [-deviceip <Device IP address>] [-ip <IP address>] [-host <Hostname>] [-fqdn <Fully Qualified Domain Name>] [-deviceid <Device ID>] -vlanid <Vlan ID> [-start <Task start date>] [-rep <Task repeat period>] [-sync] [-sessionlog <true or false>] [-retrycount <Retry count>] [-retryinterval <Retry interval>] [-comment <Snapshop comment>] [-presnapshot <true or false>] [-postsnapshot <true, false or task>] [-priority <Task priority>] [-taskname <Task name>]

Description

Return Type

String

Examples

Contents


del vlan trunk

Deletes a Vlan Trunk

Synopsis

del vlan trunk [-deviceip <Device IP address>] [-ip <IP address>] [-host <Hostname>] [-fqdn <Fully Qualified Domain Name>] [-deviceid <Device ID>] -portname <Port Name> -nativevlanid <Native vlan ID> [-start <Task start date>] [-rep <Task repeat period>] [-sync] [-sessionlog <true or false>] [-retrycount <Retry count>] [-retryinterval <Retry interval>] [-comment <Snapshop comment>] [-presnapshot <true or false>] [-postsnapshot <true, false or task>] [-priority <Task priority>] [-taskname <Task name>]

Description

Return Type

String

Examples

Contents


delete image

Delete software images from database

Synopsis

delete image [-site <partition site>] -imageset <imageset name> -images <images separated by ,>

Description

Delete software images from database

Return Type

STATUS

Examples

Contents


delete policy

Delete a policy. This command is available only with the HP Network Automation Software Ultimate edition license.

Synopsis

delete policy -policyid <Policy ID>

Description

Return Type

STATUS

Examples

Contents


delete policy rule

Delete a policy rule. This command is available only with the HP Network Automation Software Ultimate edition license.

Synopsis

delete policy rule -ruleid <Policy Rule ID>

Description

Return Type

STATUS

Examples

Contents


delete rule condition

Delete a policy rule condition. This command is available only with the HP Network Automation Software Ultimate edition license.

Synopsis

delete rule condition -ruleid <Policy Rule ID>

Description

Return Type

STATUS

Examples

Contents


delete rule exception

Deletes a policy rule exception. This command is available only with the HP Network Automation Software Ultimate edition license.

Synopsis

delete rule exception -exceptionid <Exception ID>

Description

Return Type

STATUS

Examples

Contents


deploy config

Deploy config to a device.

Synopsis

deploy config [-ip <IP address>] [-host <Hostname>] [-fqdn <Fully Qualified Domain Name>] [-deviceid <Device ID>] [-id <Config ID>] [-configtext <Config Text>] [-start <Task start date>] [-sync] -option <Deployment option> [-priority <Task priority>] [-taskname <Task name>]

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.

Return Type

String

Examples

Contents


deploy image

Deploy software images to a device.

Synopsis

deploy image -ip <device ip address> [-site <site of imageset>] -imageset <imageset name> -images <images separated by ,> [-reboot <reboot instruction>] [-rebootwait <reboot wait (in seconds)>] [-filesystem <file system of device>] [-pretask <task to run before deployment>] [-posttask <task to run after deployment>] [-verify <true|false>] [-start <Task start date>] [-comment <Snapshot comment>] [-duration <Estimated duration of snapshot task.>] [-sessionlog <true or false>] [-customname <Custom data column name>] [-customvalue <Custom data value>] [-customnames <Custom data column names>] [-customvalues <Custom data values>] [-retryInterval <Retry count>] [-retryCount <Retry interval>] [-priority <Task priority>] [-bootimage <Boot image filename>] [-bootslot <Boot image filesystem name>] [-osimage <OS image filename>] [-osslot <OS image filesystem name>] [-taskname <Task name>]

Description

Deploy software images to a device.

Return Type

String

Examples

Contents


diff config

Show the differences between two configs.

Synopsis

diff config -id1 <Config ID> -id2 <Config ID>

Description

Return Type

String

Examples

Contents


disable device

Mark a device as disabled.

Synopsis

disable device [-ip <IP address>] [-host <Hostname>] [-fqdn <Fully Qualified Domain Name>] [-deviceid <Device ID>]

Description

Return Type

STATUS

Examples

Contents


discover driver

Discover a driver for a device.

Synopsis

discover driver [-ip <IP address>] [-host <Hostname>] [-fqdn <Fully Qualified Domain Name>] [-deviceid <Device ID>] [-nosync] [-runmode <Task priority>] [-priority] [-replace] [-taskname <Task name>]

Description

Attempts to match a driver to the specified device.

Return Type

String

Examples

Contents


discover drivers

Discover drivers for all devices.

Synopsis

discover drivers [-noskip] [-group <Device group for drivers discovery>] [-priority <Task priority>] [-replace] [-runmode <Run Mode>] [-stoponfailure <Stop on Failure>] [-taskname <Task name>]

Description

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

Return Type

String

Examples

Contents


enable device

Mark a device as enabled.

Synopsis

enable device [-ip <IP address>] [-host <Hostname>] [-fqdn <Fully Qualified Domain Name>] [-deviceid <Device ID>]

Description

Return Type

STATUS

Examples

Contents


exit

Exit the system.

Synopsis

exit

Description

Exit the the system.

Return Type

None

Examples

Contents


export policy

Export configuration policies to a file. This command is available only with the HP Network Automation Software Ultimate edition license.

Synopsis

export policy -filename <export file name> -policies <policies to be exported. Specify "all" to export all policies>

Description

The export filename must be the absolute path to the file and must be directly accessible by the system.

Return Type

STATUS

Examples

Contents


fulltextsearch

Enable/disable/analyze/check status of full-text search. See the administration guide for more details.

Synopsis

fulltextsearch -option <String>

Description

Return Type

String

Examples

Contents


get external credential

Get user credentials for external services

Synopsis

get external credential -category <External redential category>

Description

Get the username and passwords used to log on toexternal applications/websites such as cisco.com and its proxy server.If current user has not defined the external credentials, the return value is null.Otherwise, the return value is a result set that contains following clear text attributes: username, password

Return Type

UserExternalCredentialVO with columns:

Examples

Contents


get snapshot

Get the config from a device.

Synopsis

get snapshot [-ip <IP address>] [-group <Groupname>] [-host <Hostname>] [-fqdn <Fully Qualified Domain Name>] [-deviceid <Device ID>] [-rep <Task repeat period>] [-sync] [-runmode <Run Mode>] [-stoponfailure <Stop on Failure>] [-start <Task start date>] [-comment <Snapshot comment>] [-duration <Estimated duration of snapshot task.>] [-sessionlog <true or false>] [-customname <Custom data column name>] [-customvalue <Custom data value>] [-customnames <Custom data column names>] [-customvalues <Custom data values>] [-retryInterval <Retry count>] [-retryCount <Retry interval>] [-priority <Task priority>] [-taskname <Task name>]

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.

Return Type

String

Examples

Contents


import

Import device or device password information.

Synopsis

import -input <Filename or CSV data> -data <device or auth> [-log <Filename>] [-append <true or false>] [-discoverafter <true or false>] [-configuresyslog <true or false>] [-usesyslogrelay <Hostname>] [-filter <Filename>] [-cleanafter <true or false>] [-deviceorigin <Any String>] [-debug <true or false>]

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

Return Type

String

Examples

Contents


import policy

Import configuration policies from a file. This command is available only with the HP Network Automation Software Ultimate edition license.

Synopsis

import policy -filename <Import file name>

Description

The import filename must contain the absolute path to the file and must be directly accessible by the system.The import file is usually created by exporting policies.

Return Type

STATUS

Examples

Contents


list access

List all access records for a device.

Synopsis

list access [-ip <IP address>] [-host <Hostname>] [-fqdn <Fully Qualified Domain Name>] [-deviceid <Device ID>] [-start <Date>] [-end <Date>]

Description

Return Type

Collection:DeviceAccessLogVO with columns:

Examples

Contents


list access all

List all access records for all devices.

Synopsis

list access all

Description

Return Type

Collection:DeviceAccessLogVO with columns:

Examples

Contents


list acl

List ACLs.

Synopsis

list acl [-host <Host Name>] [-ip <IP Address>] [-fqdn <Fully Qualified Domain Name>] [-deviceid <Device ID>] [-aclid <ACL ID>] [-handle <Handle>] [-recent <Most Recent (true|false)>] [-includescript] [-includeapplication]

Description

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

Return Type

Collection:DeviceACLVO with columns:

Examples

Contents


list all drivers

List all drivers installed in the system.

Synopsis

list all drivers

Description

Return Type

String

Examples

Contents


list authentication

list Authentication.

Synopsis

list authentication [-rulename <Rule Name>]

Description

Displays the Authentication Rules by Rule Name.

Return Type

Collection:AuthenticationRuleVO with columns:

Examples

Contents


list basicip

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

Synopsis

list basicip [-ip <IP address>] [-host <Hostname>] [-fqdn <Fully Qualified Domain Name>] [-deviceid <Device ID>] [-start <Date>] [-end <Date>]

Description

Return Type

Collection:DeviceDataVO with columns:

Examples

Contents


list config

List all configs for the specified device.

Synopsis

list config [-ip <IP address>] [-host <Hostname>] [-fqdn <Fully Qualified Domain Name>] [-deviceid <Device ID>] [-start <Date>] [-end <Date>] [-size] [-ids <Config ID List>]

Description

Return Type

Collection:DeviceDataVO with columns:

Examples

Contents


list config all

List all configs for all devices.

Synopsis

list config all

Description

Return Type

Collection:DeviceDataVO with columns:

Examples

Contents


list config id

List config IDs for the specified configs.

Synopsis

list config id [-ip <IP address>] [-host <Hostname>] [-fqdn <Fully Qualified Domain Name>] [-deviceid <Device ID>] [-start <Date>] [-end <Date>] [-id <Config ID>]

Description

Return Type

Collection:IntegerVO

Examples

Contents


list core

Lists all cores, including those in standby status

Synopsis

list core

Description

Lists all cores in the current mesh including standby cores, which do not participate.

Return Type

Collection:CoreVO with columns:

Examples

Contents


list custom data definition

list Custom Data Definition.

Synopsis

list custom data definition -tablename <Table Name>

Description

List Custom Data Definition by table name.

Return Type

Collection:CustomDataVO with columns:

Examples

Contents


list device

List devices.

Synopsis

list device [-software <Software Version>] [-vendor <Device Vendor>] [-type <Device Type>] [-model <Device Model>] [-family <Device Family>] [-group <Device Group>] [-disabled] [-pollexcluded] [-ids <Device ID List>] [-hierarchy <Hierarchy Layer>] [-host <Device Host Name>] [-ip <Device IP Address>] [-realm <Realm Name>] [-startid <ID>] [-limitcount <Count>] [-vtpdomain <VTP Domain>]

Description

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

Return Type

Collection:DeviceVO with columns:

Examples

Contents


list device context variables

List Device Context Variables

Synopsis

list device context variables -deviceid <Device ID> -action <Action>

Description

Adding device contexts requires device specific parameters. This command lists the device context variables needed to perform a context addition or removal. For example, one device might require a context name and a config location, while a different device might require a context name and a slot number. This command will list what is needed for the device you are working on. This information is then used as input into the add device context command.

Return Type

String

Examples

Contents


list device data

List configuration and diagnostic data records for the specified device.

Synopsis

list device data -ip <IP address> [-dataType <Data type>]

Description

Return Type

Collection:DeviceDataVO with columns:

Examples

Contents


list device family

List device families.

Synopsis

list device family [-software <Software Version>] [-vendor <Device Vendor>] [-type <Device Type>] [-model <Device Model>] [-group <Device Group>]

Description

Lists device families in the system.

Return Type

Collection:StringVO

Examples

Contents


list device group

List device groups that contain one or more devices.

Synopsis

list device group [-software <Software Version>] [-vendor <Device Vendor>] [-type <Device Type>] [-model <Device Model>] [-family <Device Family>] [-parent <Parent Device Group Name>]

Description

Lists the device groups that match the specified device criteria. If no argument is provided, lists all device groups that contain at least one device.

Return Type

Collection:StringVO

Examples

Contents


list device id

list device IDs.

Synopsis

list device id [-software <Software Version>] [-vendor <Device Vendor>] [-type <Device Type>] [-model <Device Model>] [-family <Device Family>] [-group <Device Group>] [-disabled] [-pollexcluded] [-id <Device ID>] [-host <Device Host Name>] [-ip <Device IP Address>] [-realm <Realm Name>] [-hierarchy <Hierarchy Layer>] [-viewable_by <Viewable By>]

Description

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

Return Type

Collection:IntegerVO

Examples

Contents


list device model

List device model names.

Synopsis

list device model [-software <Software Version>] [-vendor <Device Vendor>] [-type <Device Type>] [-family <Device Family>] [-group <Device Group>]

Description

Lists device model names in the system.

Return Type

Collection:StringVO

Examples

Contents


list device nnm

list all devices with an NNMi node uuid

Synopsis

list device nnm

Description

Lists all devices with an NNMi UUID.

Return Type

Collection:DeviceVO with columns:

Examples

Contents


list device relationships

List Device relationships

Synopsis

list device relationships [-relationshipid <Relationship ID>] [-origindeviceid <Originating Device ID>] [-destdeviceid <Destination Device ID>] [-relationshiptypeid <Relationship Type ID>] [-createdby <Created By>]

Description

List device relationships based on the search criteria.

Return Type

Collection:DeviceRelationshipVO with columns:

Examples

Contents


list device software

List device software versions.

Synopsis

list device software [-vendor <Device Vendor>] [-type <Device Type>] [-model <Device Model>] [-family <Device Family>] [-group <Device Group>]

Description

Lists device software versions in the system.

Return Type

Collection:StringVO

Examples

Contents


list device template

List device templates.

Synopsis

list device template [-deviceip <Device IP>] [-deviceid <Device ID>] [-vendor <Device Vendor>] [-type <Device Type>] [-model <Device Model>] [-host <Device Host Name>]

Description

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

Return Type

Collection:DeviceVO with columns:

Examples

Contents


list device type

List device types.

Synopsis

list device type [-software <Software Version>] [-vendor <Device Vendor>] [-model <Device Model>] [-family <Device Family>] [-group <Device Group>]

Description

Lists device types in the system.

Return Type

Collection:StringVO

Examples

Contents


list device vendor

List device manufacturers.

Synopsis

list device vendor [-software <Software Version>] [-type <Device Type>] [-model <Device Model>] [-family <Device Family>] [-group <Device Group>]

Description

Lists device manufacturers in the system.

Return Type

Collection:StringVO

Examples

Contents


list device vtp

Lists all Devices in a particular VTP domain

Synopsis

list device vtp -domain <Domain name>

Description

Return Type

Collection:DeviceVTPVO with columns:

Examples

Contents


list deviceinfo

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

Synopsis

list deviceinfo [-ip <IP address>] [-host <Hostname>] [-fqdn <Fully Qualified Domain Name>] [-deviceid <Device ID>] [-deviceip <IP address>]

Description

Return Type

Collection:DeviceDataVO with columns:

Examples

Contents


list diagnostic

For the given device, list all configs for which the given diagnostic may be shown.

Synopsis

list diagnostic -diagnostic <Diagnostic Name> [-ip <IP address>] [-host <Hostname>] [-fqdn <Fully Qualified Domain Name>] [-deviceid <Device ID>] [-start <Date>] [-end <Date>]

Description

Return Type

Collection:DeviceDataVO with columns:

Examples

Contents


list diagnostic all

List all diagnostics for all devices.

Synopsis

list diagnostic all

Description

Return Type

Collection:DeviceDataVO with columns:

Examples

Contents


list event

List events. However, with the HP Network Automation Software Premium edition license, using this command, you cannot view the following events:

Synopsis

list event [-ip <IP address>] [-host <Hostname>] [-fqdn <Fully Qualified Domain Name>] [-deviceid <Device ID>] [-type <Event Type>] [-start <Date>] [-end <Date>]

Description

Lists all the events and system messages

Return Type

Collection:EventVO with columns:

Examples

Contents


list group id

List all device groups or user groups viewable by userID.

Synopsis

list group id -type <Type> [-viewable_by <Viewable By>]

Description

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

Return Type

Collection:IntegerVO

Examples

Contents


list groups

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

Synopsis

list groups -type <Type> [-ip <IP address>] [-host <Hostname>] [-fqdn <Fully Qualified Domain Name>] [-deviceid <Device ID>] [-parent <Parent Group Name>] [-grouptype <dynamic|static>]

Description

Return Type

Collection:DeviceGroupVO with columns:

Examples

Contents


list icmp

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

Synopsis

list icmp [-ip <IP address>] [-host <Hostname>] [-fqdn <Fully Qualified Domain Name>] [-deviceid <Device ID>] [-start <Date>] [-end <Date>]

Description

Return Type

Collection:DeviceDataVO with columns:

Examples

Contents


list image

List images in database or device.

Synopsis

list image [-ip <ip address>] [-site <partition site>] [-imageset <imageset name>]

Description

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

Return Type

Collection:DeviceSoftwareImageVO with columns:

Examples

Contents


list imageoption

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

Synopsis

list imageoption -name <device property name (model|processor|bootrom)>

Description

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

Return Type

Collection:StringVO

Examples

Contents


list imageset

List imageset in database.

Synopsis

list imageset [-site <partition site>]

Description

List imageset in database

Return Type

Collection:SoftwareImageSetVO with columns:

Examples

Contents


list int

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

Synopsis

list int [-ip <IP address>] [-host <Hostname>] [-fqdn <Fully Qualified Domain Name>] [-deviceid <Device ID>] [-start <Date>] [-end <Date>]

Description

Return Type

Collection:DeviceDataVO with columns:

Examples

Contents


list ip

List ip.

Synopsis

list ip [-deviceip <Device IP address>] [-ip <IP address>] [-host <Hostname>] [-fqdn <Fully Qualified Domain Name>] [-deviceid <Device ID>]

Description

Lists ip addresses for specific device.

Return Type

Collection:IpVO with columns:

Examples

Contents


list ip all

List all secondary ip.

Synopsis

list ip all

Description

List all secondary ip addresses in the system.

Return Type

Collection:IpVO with columns:

Examples

Contents


list metadata

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

Synopsis

list metadata -table <Database Table> -associatedtableid <Matching Row ID>

Description

Return Type

Collection:MetadataVO with columns:

Examples

Contents


list metadata field

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

Synopsis

list metadata field -table <Database Table>

Description

Return Type

Collection:MetadataFieldVO with columns:

Examples

Contents


list module

List modules (or blades) in the system.

Synopsis

list module [-model <Model Number>] [-type <Module Description>] [-firmware <Firmware Version>] [-hardware <Hardware Revision>] [-memory <Memory>] [-comment <Comment>] [-ip <IP address>] [-host <Hostname>] [-fqdn <Fully Qualified Domain Name>] [-deviceid <Device ID>] [-group <Device Group Name>]

Description

Return Type

Collection:DeviceModuleVO with columns:

Examples

Contents


list ospfneighbor

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

Synopsis

list ospfneighbor [-ip <IP address>] [-host <Hostname>] [-fqdn <Fully Qualified Domain Name>] [-deviceid <Device ID>] [-start <Date>] [-end <Date>]

Description

Return Type

Collection:DeviceDataVO with columns:

Examples

Contents


list partition

Show details for a single view.

Synopsis

list partition -viewname <View Name>

Description

Show details for a single parition.

Return Type

Collection:DeviceGroupVO with columns:

Examples

Contents


list policies

List configuration policies. This command is available only with the HP Network Automation Software Ultimate edition license.

Synopsis

list policies

Description

List configuration policies.

Return Type

Collection:ConfigPolicyVO with columns:

Examples

Contents


list policy id

Lists IDs of all policies that apply to a given device. This command is available only with the HP Network Automation Software Ultimate edition license.

Synopsis

list policy id -deviceid <Device ID>

Description

Return Type

Collection:IntegerVO

Examples

Contents


list policy rule

Lists all rules of a policy. This command is available only with the HP Network Automation Software Ultimate edition license.

Synopsis

list policy rule -policyid <Policy ID>

Description

Return Type

Collection:ConfigRuleVO with columns:

Examples

Contents


list port

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

Synopsis

list port [-ip <IP address>] [-host <Hostname>] [-fqdn <Fully Qualified Domain Name>] [-deviceid <Device ID>]

Description

Ports are ports and interfaces found on the devices in their configuration or within ancillary commands that detail specifics of the ports and interfaces. The values returned have been processed by the device drivers.

Return Type

Collection:DevicePortVO with columns:

Examples

Contents


list port channels

Lists all port channels on a specific device

Synopsis

list port channels [-deviceip <Device IP address>] [-ip <IP address>] [-host <Hostname>] [-fqdn <Fully Qualified Domain Name>] [-deviceid <Device ID>]

Description

Return Type

Collection:PortChannelVO with columns:

Examples

Contents


list relationship type

Lists the relationship type details.

Synopsis

list relationship type [-id <Relationship type ID>] [-modifiable <Modifiable>]

Description

Lists all the available relationship types in the system.

Return Type

Collection:RelationshipTypeVO with columns:

Examples

Contents


list relationships for device

Lists all the relationships defined for a device in the system.

Synopsis

list relationships for device -ip <IP address> [-hostname <Hostname>] [-domain <Fully Qualified Domain Name>] [-deviceid <Device ID>] [-relationshiptypeids <Relationship IDs>] [-createdby <Created By>] [-filteroriginating <Filter Orginating>] [-filterdestination <Filter Destination>] [-modifiable <Modifiable>]

Description

Lists the different relationships that a device is participating in. The arguments will allow to filter the results.

Return Type

Collection:DeviceRelationshipVO with columns:

Examples

Contents


list resource id

List all resource identities in a resource identity pool.

Synopsis

list resource id -poolid <Resource identity pool ID>

Description

List all resource identities in a resource identity pool.

Return Type

Collection:ResourceIdentityVO with columns:

Examples

Contents


list resource id custom field data

List custom field data for a resource identity.

Synopsis

list resource id custom field data -resourceidentityid <Resource identity ID>

Description

List custom field data for a resource identity.

Return Type

Collection:ResourceIdentityCustomFieldVO with columns:

Examples

Contents


list resource id pool

List all resource identity pools associated with a given site.

Synopsis

list resource id pool [-site <Site Name>]

Description

List all resource identity pools associated with a given site.

Return Type

Collection:ResourceIdentityPoolVO with columns:

Examples

Contents


list resource id pool all

List all resource identity pools on the system.

Synopsis

list resource id pool all

Description

List all resource identity pools on the system.

Return Type

Collection:ResourceIdentityPoolVO with columns:

Examples

Contents


list role

List roles

Synopsis

list role [-type <Role type>]

Description

List the user roles that are known to the system.

Return Type

Collection:RoleVO with columns:

Examples

Contents


list routing

List all routing tables for a device.

Synopsis

list routing [-ip <IP address>] [-host <Hostname>] [-fqdn <Fully Qualified Domain Name>] [-deviceid <Device ID>] [-start <Date>] [-end <Date>]

Description

Return Type

Collection:DeviceDataVO with columns:

Examples

Contents


list rule condition

Lists all conditions of a policy rule. This command is available only with the HP Network Automation Software Ultimate edition license.

Synopsis

list rule condition -ruleid <Rule ID>

Description

Return Type

Collection:RuleConditionVO with columns:

Examples

Contents


list script

List command scripts, advanced scripts and/or diagnostics.

Synopsis

list script [-type <Type>] [-scripttype <Script Type>] [-name <Name>] [-mode <Mode>] [-ids <Script ID List>] [-sitename <Site Name>]

Description

Return Type

Collection:CustomScriptVO with columns:

Examples

Contents


list script id

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

Synopsis

list script id [-type <Type>] [-scripttype <Script Type>] [-name <Name>] [-mode <Mode>] [-id <ID>]

Description

Return Type

Collection:IntegerVO

Examples

Contents


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.

Synopsis

list script mode [-ip <IP address>] [-host <Hostname>] [-fqdn <Fully Qualified Domain Name>] [-deviceid <Device ID>] [-id <Device ID>] [-type <Type>]

Description

Return Type

Collection:StringVO

Examples

Contents


list session

List all interceptor log records for a device.

Synopsis

list session [-ip <IP address>] [-start <Date>] [-end <Date>]

Description

Return Type

Collection:InterceptorLogVO with columns:

Examples

Contents


list site

List all Sites in the system.

Synopsis

list site [-name <Site Name>] [-id <Site ID>] [-coreid <Core ID>]

Description

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

Return Type

Collection:SiteVO with columns:

Examples

Contents


list sys oids all

List all sys oids supported by the system.

Synopsis

list sys oids all

Description

List all sys oids in the system.

Return Type

Collection:StringVO

Examples

Contents


list system message

List system messages.

Synopsis

list system message [-ip <IP address>] [-host <Hostname>] [-fqdn <Fully Qualified Domain Name>] [-deviceid <Device ID>] [-start <Date>] [-end <Date>]

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.

Return Type

Collection:EventVO with columns:

Examples

Contents


list task

Display a list of tasks. However, with the HP Network Automation Software Premium edition license, you cannot view the 'Check Policy Compliance' tasks using this command.

Synopsis

list task [-ip <IP address>] [-host <Hostname>] [-fqdn <Fully Qualified Domain Name>] [-deviceid <Device ID>] [-start <Task start date>] [-end <Task end date>] [-parentid <Parent task ID>] [-status <Task status>] [-id <Task ID>] [-type <Task Type>] [-name <Task Name>] [-priorities <Task priority values>] [-coreid <Core ID>]

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.

Return Type

Collection:ScheduleTaskVO with columns:

Examples

Contents


list task all

List all tasks.

Synopsis

list task all

Description

Equivalent to "list task".

Return Type

Collection:ScheduleTaskVO with columns:

Examples

Contents


list template devices

List template devices.

Synopsis

list template devices -id <Template ID>

Description

Lists all devices in the system which can use the given template

Return Type

Collection:DeviceVO with columns:

Examples

Contents


list topology

List Device Information from Topology Data.

Synopsis

list topology [-mac <MAC Address>] [-ip <IP Address>]

Description

Return Type

Collection:DeviceTopologyConnectionVO with columns:

Examples

Contents


list topology graph

List probable Layer 1 topology data.

Synopsis

list topology graph [-deviceids <List of Device IDs>] [-deviceportids <List of Device Port IDs>] [-serverids <List of Server IDs>] [-serverportids <List of Server Interface IDs>] [-deviceid <A Device ID>]

Description

Return Type

Collection:DeviceTopologyDataVO with columns:

Examples

Contents


list topology ip

List IP address Topology Data.

Synopsis

list topology ip [-deviceip <Device IP/hostname>] [-portid <Device Port ID>] [-notcurrent < >] [-type <(all|internal|connected)>] [-ip <IP address>] [-host <Hostname>] [-fqdn <Fully Qualified Domain Name>] [-deviceid <Device ID>]

Description

Return Type

Collection:DeviceTopologyDataVO with columns:

Examples

Contents


list topology mac

List MAC address Topology Data.

Synopsis

list topology mac [-deviceip <Device IP/hostname>] [-portid <Device Port ID>] [-notcurrent < >] [-type <(all|internal|connected)>] [-ip <IP address>] [-host <Hostname>] [-fqdn <Fully Qualified Domain Name>] [-deviceid <Device ID>]

Description

Return Type

Collection:DeviceTopologyDataVO with columns:

Examples

Contents


list trunk port

Lists all trunk ports on a specific device

Synopsis

list trunk port [-deviceip <Device IP address>] [-ip <IP address>] [-host <Hostname>] [-fqdn <Fully Qualified Domain Name>] [-deviceid <Device ID>]

Description

Return Type

Collection:DevicePortVO with columns:

Examples

Contents


list user

List users.

Synopsis

list user [-group <User group name>]

Description

List users known to the system.

Return Type

Collection:UserVO with columns:

Examples

Contents


list user id

List all users viewable by userID.

Synopsis

list user id [-viewable_by <Viewable By>]

Description

List all users viewable by a particular user.

Return Type

Collection:IntegerVO

Examples

Contents


list user site

List all sites for a specific user in the system.

Synopsis

list user site [-u <User Name>] [-id <User ID>]

Description

Result includes the site ID/name, core ID, and the Realm.

Return Type

Collection:SiteVO with columns:

Examples

Contents


list view

display the views defined within the system.

Synopsis

list view

Description

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

Return Type

Collection:DeviceViewVO with columns:

Examples

Contents


list vlan

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

Synopsis

list vlan [-deviceip <Device IP/Hostname>] [-ip <IP address>] [-host <Hostname>] [-fqdn <Fully Qualified Domain Name>] [-deviceid <Device ID>]

Description

Return Type

Collection:DeviceVlanInfoVO with columns:

Examples

Contents


list vlan on port

List Vlan's on a specific Port.

Synopsis

list vlan on port -portid <Port ID>

Description

List Vlan's on a specific Port.

Return Type

Collection:PortVlanVO with columns:

Examples

Contents


list vlan ports

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

Synopsis

list vlan ports [-deviceip <Device IP address>] [-ip <IP address>] [-host <Hostname>] [-fqdn <Fully Qualified Domain Name>] [-deviceid <Device ID>] -vlanid <Vlan ID>

Description

Return Type

Collection:DevicePortVO with columns:

Examples

Contents


list vtp domain

Lists all the VTP Domains

Synopsis

list vtp domain

Description

Lists all the VTP Domains in NA

Return Type

Collection:DeviceVTPVO with columns:

Examples

Contents


login

Synopsis

login -username <Username> -password <Password> [-host <Host>]

Description

Return Type

None

Contents


logout

Synopsis

logout -sessionid <Session ID>

Description

Return Type

None

Contents


mod advanced diagnostic

Modify an existing advanced diagnostic.

Synopsis

mod advanced diagnostic [-id <Diagnostic ID>] [-name <Diagnostic Name>] [-newname <New Name>] [-description <New Description>] [-family <New Device Family>] [-language <New Script Language>] [-parameters <New Parameters>] [-script <New Script Text>] [-sitename <Site name>]

Description

Modify the indicated advanced diagnostic. 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.

Return Type

STATUS

Examples

Contents


mod advanced script

Modify an existing advanced script.

Synopsis

mod advanced script [-id <Script ID>] [-name <Script Name>] [-newname <New Name>] [-description <New Description>] [-scripttype <New Script Type>] [-family <New Device Family>] [-language <New Script Language>] [-parameters <New Parameters>] [-script <New Script Text>] [-sitename <Site name>]

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.

Return Type

STATUS

Examples

Contents


mod authentication

Modify device password information.

Synopsis

mod authentication -loc <Location> [-ip <IP address>] [-host <Hostname>] [-fqdn <Fully Qualified Domain Name>] [-deviceid <Device ID>] [-snmpro <Read only community string(s)>] [-snmprw <Read write community string(s)>] [-snmpv3user <SNMPv3 Username>] [-snmpv3authpw <SNMPv3 Authentication Password>] [-snmpv3encryptpw <SNMPv3 Encryption Password>] [-user <Username>] [-passwd <Password>] [-enablepasswd <Enable password>] [-connectionmethods <Connection methods>] [-accessvariables <Access variables>] [-start <Task start date>] [-appendsnmpro] [-appendsnmprw] [-sync] [-group <Group name>] [-site <Password Rule partition site>] [-rulename <Password Rule name>] [-rulehostname <Rule hostname>] [-ruledevicegroup <Rule device group>] [-iprangestart <Rule ip start range>] [-iprangeend <Rule ip end range>] [-taskname <Task Name>]

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.

Return Type

String

Examples

Contents


mod command script

Modify an existing command script.

Synopsis

mod command script [-id <Script ID>] [-name <Script Name>] [-newname <New Name>] [-description <New Description>] [-scripttype <New Script Type>] [-mode <New Mode>] [-driver <New Driver List>] [-script <New Script Text>] [-sitename <Site Name>]

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.

Return Type

STATUS

Examples

Contents


mod custom data

Modify an existing piece of custom data.

Synopsis

mod custom data -tablename <Table Name> -columnname <Column Name> [-fieldname <Field Name>] [-fieldlabel <Field Label>] [-flags <Flags>] [-inuse <In Use>] [-fieldvalues <Field Values>]

Description

Return Type

CustomDataVO with columns:

Examples

Contents


mod device

Modify the properties of a device.

Synopsis

mod device [-ip <IP address>] [-host <Hostname>] [-fqdn <Fully Qualified Domain Name>] [-deviceid <Device ID>] [-hostname <New Hostname>] [-comment <Comment>] [-description <Device name>] [-model <Device model>] [-vendor <Device vendor>] [-domain <Domain name>] [-serial <Serial number>] [-asset <Asset tag>] [-location <Location>] [-status <Status>] [-nopoll <Do not poll>] [-newIP <New IP address>] [-consoleip <Console IP address, if using console server>] [-consoleport <Console Port>] [-tftpserverip <TFTP server IP address, if using NAT>] [-natip <NAT IP address>] [-customname <Custom data column name>] [-customvalue <Custom data value>] [-customnames <Custom data column names>] [-customvalues <Custom data values>] [-useconsoleserver <true or false>] [-accessmethods <Comma-separated list of access methods>] [-hierarchylayer <Hierarchy layer>]

Description

Return Type

STATUS

Examples

Contents


mod device group

Modify a device group.

Synopsis

mod device group -name <Name> [-newname <New name>] [-comment <Comment>] [-customname <Custom data column name>] [-customvalue <Custom data value>] [-customnames <Custom data column names>] [-customvalues <Custom data values>] [-shared <Shared>] [-newtype <dynamic|static>] [-criteria <Criteria>] [-searchgroups <Search groups>] [-limitsearchgroups <Limit to search groups>] [-partitions <Partitions>]

Description

Modify the name, comments, and/or the search criteria of a device group.

Return Type

STATUS

Examples

Contents


mod device relationship

Modify the relationship type defined between the devices.

Synopsis

mod device relationship -relationshipid <Relationship ID> -newrelationshiptypeid <New Relationship Type ID>

Description

Modify the relationship identified by relationship id between two devices to a new relationship type.

Return Type

VO:DeviceRelationshipVO with columns:

Examples

Contents


mod device template

Modify the properties of a device template.

Synopsis

mod device template -templateid <Device Template ID> [-hostname <Device name>] [-newdriver <Driver name>] [-comment <Comment>] [-description <Description>] [-model <Device model>] [-vendor <Device vendor>] [-location <Location>] [-customname <Custom data column name>] [-customvalue <Custom data value>] [-customnames <Custom data column names>] [-customvalues <Custom data values>] [-accessmethods <Comma-separated list of access methods>] [-hierarchylayer <Hierarchy layer>] [-sitename <Site Name>]

Description

Return Type

STATUS

Examples

Contents


mod device template config

Modify the config of a device template.

Synopsis

mod device template config -templateid <Device Template ID> [-configtext <Device template configuration text>] [-configfile <Device template config file name>]

Description

Return Type

STATUS

Examples

Contents


mod diagnostic

Modify an existing custom diagnostic script.

Synopsis

mod diagnostic [-id <Diagnostic ID>] [-name <Diagnostic Name>] [-newname <New Name>] [-description <New Description>] [-mode <New Mode>] [-driver <New Driver List>] [-script <New Script Text>] [-sitename <Site name>]

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.

Return Type

STATUS

Examples

Contents


mod group

Modify a group.

Synopsis

mod group -type <Type> -name <Name> [-newname <New name>] [-comment <Comment>] [-customname <Custom data column name>] [-customvalue <Custom data value>] [-customnames <Custom data column names>] [-customvalues <Custom data values>] [-shared <Shared>]

Description

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

Return Type

STATUS

Examples

Contents


mod ip

Modify the properties of a ip.

Synopsis

mod ip -ipvalue <Value> [-deviceip <Device IP address>] [-ip <IP address>] [-host <Hostname>] [-fqdn <Fully Qualified Domain Name>] [-deviceid <Device ID>] [-comment <Comment>] [-usetoaccess <Use to Access Device>]

Description

Return Type

String

Examples

Contents


mod metadata

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

Synopsis

mod metadata -metadataid <Metadata ID> [-fieldid <Metadata Field ID>] [-data <Data>] [-associatedtableid <Matching Row ID>]

Description

Return Type

MetadataVO with columns:

Examples

Contents


mod metadata field

Used to modify an existing custom data field.

Synopsis

mod metadata field -fieldid <Field ID> [-fieldname <Field Name>] [-fieldvalues <Field Values>] [-inuse <In Use>] [-flags <Allow HTML>] [-associatedtable <Associated Table>]

Description

Return Type

MetadataFieldVO with columns:

Examples

Contents


mod module

Modify a module's properties.

Synopsis

mod module -id <Module ID> [-comment <Comment>] [-customname <Custom data column name>] [-customvalue <Custom data value>] [-customnames <Custom data column names>] [-customvalues <Custom data values>]

Description

Return Type

STATUS

Examples

Contents


mod oraclecaseinsensitive

Enable or disable case-insensitive search for Oracle. See the administration guide for more details.

Synopsis

mod oraclecaseinsensitive -option <String>

Description

Return Type

String

Examples

Contents


mod partition

Modify a partition.

Synopsis

mod partition -name <Name> [-newname <New name>] [-comment <Comment>] [-realm <Realm Name>] [-managingcoreid <Managing Core Id>]

Description

Return Type

STATUS

Examples

Contents


mod policy

Modify a policy. This command is available only with the HP Network Automation Software Ultimate edition license.

Synopsis

mod policy [-name <Policy Name>] [-policyid <Policy ID>] [-site <Site Name>] [-newname <New Name>] [-tag <Policy Tag>] [-desc <Policy Description>] [-dg <Policy Scope>] [-exceptions <Policy Exceptions>] [-status <Policy Status (active|inactive)>] [-cve <CVE>] [-aurl <Vendor Advisory URL>] [-surl <Vendor Solution URL>] [-ddate <Disclosure Date>] [-solution <Solution>]

Description

It modifies an existing policy. Note that the policy must be identified by either policy ID or policy name. Please also see the description for 'create policy' command.

Return Type

ConfigPolicyVO with columns:

Examples

Contents


mod policy rule

Modify a policy rule. This command is available only with the HP Network Automation Software Ultimate edition license.

Synopsis

mod policy rule -ruleid <Policy Rule ID> [-newname <New Name>] [-devicefamily <Device Family (type 'all' to apply to all device families)>] [-drivers <Drivers (comma separated internal names of drivers)>] [-importance <Importance (informationa|low|medium|high|critical)>] [-useblock <Define Block Start/End Patterns (true|false)>] [-textblockstartpattern <Text Block Start Regex Pattern, or null to remove existing>] [-textblockendpattern <Text Block End Regex Pattern, or null to remove existing>] [-desc <Rule Description>] [-details <Detailed Description>]

Description

The command modifies an existing policy rule that is identified by rule ID. Please also see the description for 'create policy rule' command.

Return Type

ConfigRuleVO with columns:

Examples

Contents


mod port

Modify a port's properties.

Synopsis

mod port -id <Port ID> [-comment <Comment>] [-customname <Custom data column name>] [-customvalue <Custom data value>] [-customnames <Custom data column names>] [-customvalues <Custom data values>]

Description

Return Type

STATUS

Examples

Contents


mod resource id custom field data

Modify custom field data for a resource identity.

Synopsis

mod resource id custom field data [-fielddataid <Custom field data ID>] [-resourceidentityid <Resource Identity ID>] [-fieldname <Custom field name>] [-data <Custom field data>]

Description

Modify custom field data for a resource identity. Resource identity custom field data can be identified either by a custom field data ID (-fielddataid) or a combination of custom field name (-fieldname) and resource identity ID (-resourceidentityid). If resource identity custom field data ID is specified, custom field name and resource identity ID are ignored. If custom field data is not specified, the field value is set to null.

Return Type

STATUS

Examples

Contents


mod resource id pool

Modify an existing resource identity pool identified by a resource identity pool ID

Synopsis

mod resource id pool -id <ID> [-name <Name>] [-description <Description>] [-site <Site Name>] [-addcustomfieldid <Custom Field ID>] [-removecustomfieldid <Custom Field ID>]

Description

Modify an existing resource identity pool identified by a resource identity pool ID

Return Type

VO:ResourceIdentityPoolVO with columns:

Examples

Contents


mod role

Change an existing user role of type modify device partition or view partition permission.

Synopsis

mod role -name <Role name> -resources <Resources> [-viewname <Device view name>] [-desc <Description>]

Description

Change an existing user role of type modify device partition or view partition permission.

Return Type

STATUS

Examples

Contents


mod rule condition

Modify a policy rule condition

Synopsis

mod rule condition -rcid <Rule Condition ID> [-operator <Operator Name>] [-operand <Operand (text or regex pattern)>] [-exceptionoperand <Except Operand (Second operand, for 'must contain only' operator>] [-regex <Regex (true|false)>] [-exactorder <Exact Order (true|false)>]

Description

This command is available only with the HP Network Automation Software Ultimate edition license.It modifies an existing rule condition that is identified by rule condition ID (use 'list rule condition' command to see IDs). Note that data model element name cannot be modified. Please also see the description for 'create rule condition' command.

Return Type

RuleConditionVO with columns:

Examples

Contents


mod server option

Modify the setting of a server option

Synopsis

mod server option -name <Option Name> -value <Option Value> -persistent <true/false>

Description

Modify the value of an Admin Setting or server configuration option.

Return Type

STATUS

Examples

Contents


mod site

Modifies the managing core of the site.

Synopsis

mod site -name <Site Name> [-managingcoreid <Managing Core ID>]

Description

Modifies a site.

Return Type

STATUS

Examples

Contents


mod task

Modify a scheduled task.

Synopsis

mod task -id <Task ID> [-comment <Comment>] [-retryInterval <Retry interval>] [-expensive] [-notexpensive] [-days <Days>] [-retryCount <Retry count>] [-repeatType <Repeat type>] [-duration <Duration>] [-start <Start>] [-repeatInterval <Repeat interval>] [-approve <Approval comment>] [-reject <Reason the task is not approved>] [-override <Reason for overriding approval process>] [-customname <Custom data column name>] [-customvalue <Custom data value>] [-customnames <Custom data column names>] [-customvalues <Custom data values>] [-sessionlog <true or false>] [-priority <Task priority>] [-coreid <Core ID>] [-taskname <Task name>]

Description

Return Type

STATUS

Examples

Contents


mod topology graph

Modify topology data.

Synopsis

mod topology graph -type <Topology data type> -data <Topology data value> -deviceid <Device ID> [-deviceportid <Device ID>] [-remotedeviceid <Device ID>] [-remotedeviceportid <Device ID>] [-serverid <Server ID>] [-serverportid <Server ID>]

Description

Return Type

String

Examples

Contents


mod unmanaged device

Modify the properties of an unmanaged device.

Synopsis

mod unmanaged device -ip <IP address> -comment <Comment>

Description

Return Type

STATUS

Examples

Contents


mod user

Modify a user's properties.

Synopsis

mod user -u <Username> [-p <Password>] [-fn <First name>] [-ln <Last name>] [-email <Email address>] [-priv <User Privilege>] [-newusername <Username>] [-aaausername <Username>] [-aaapassword <AAA Password>] [-useaaaloginforproxy <Use AAA Logins for Proxy (yes|no)>] [-extauthfailover <Allow External Auth Failover (yes|no)>] [-customname <Custom data column name>] [-customvalue <Custom data value>] [-customnames <Custom data column names>] [-customvalues <Custom data values>] [-status <Enable or Disable the user (enable|disable)>] [-view1partition <view1partitionname>] [-view2partition <view2partitionname>] [-view3partition <view3partitionname>]

Description

Return Type

STATUS

Examples

Contents


mod user group

Modify a user group.

Synopsis

mod user group -name <Name> [-newname <New name>] [-description <Description>] [-cmdperms <command permissions>] [-deviceperms <device permissions>] [-scriptperms <script permissions>] [-viewperms <view permissions>] [-view1partition <view1parition name>] [-view2partition <view2parition name>] [-view3partition <view3parition name>]

Description

Modify the description of a usergroup.

Return Type

STATUS

Examples

Contents


mod vlan

Edits a Vlan - Rename Vlan Name, Add ports or Remove ports

Synopsis

mod vlan [-deviceip <Device IP address>] [-ip <IP address>] [-host <Hostname>] [-fqdn <Fully Qualified Domain Name>] [-deviceid <Device ID>] -vlanid <Vlan ID> [-renameto <New Vlan Name>] [-addports <Add Port IDs>] [-removeports <Remove Port IDs>] [-start <Task start date>] [-rep <Task repeat period>] [-sync] [-sessionlog <true or false>] [-retrycount <Retry count>] [-retryinterval <Retry interval>] [-comment <Snapshop comment>] [-presnapshot <true or false>] [-postsnapshot <true, false or task>] [-priority <Task priority>] [-taskname <Task name>]

Description

Return Type

String

Examples

Contents


mod vlan trunk

Edit a Vlan Trunk - Adds and Removes Vlans

Synopsis

mod vlan trunk [-deviceip <Device IP address>] [-ip <IP address>] [-host <Hostname>] [-fqdn <Fully Qualified Domain Name>] [-deviceid <Device ID>] -portname <Port Name> -nativevlanid <Native vlan ID> [-addvlanids <Add Vlan IDs>] [-removevlanids <Remove Vlan IDs>] [-start <Task start date>] [-rep <Task repeat period>] [-sync] [-sessionlog <true or false>] [-retrycount <Retry count>] [-retryinterval <Retry interval>] [-comment <Snapshop comment>] [-presnapshot <true or false>] [-postsnapshot <true, false or task>] [-priority <Task priority>] [-taskname <Task name>]

Description

Return Type

String

Examples

Contents


os ping

Run a ping command from the server to the sepecified device.

Synopsis

os ping

Description

The ping command is an OS command. All ping options that are available at the OS level are supported. Users should be able to enter any host name or address. The behavior is that it simply passes the string to the OS, executes it as a command and returns the results of the executed command.

Return Type

None

Examples

Contents


os traceroute

Run a traceroute command from the server to the sepecified device.

Synopsis

os traceroute

Description

The traceroute command is an OS command. All traceroute options that are available at the OS level are supported. Users should be able to enter any options the command supported. The behavior is that it simply passes the command to the OS, executes it and returns the results of the executed command.

Return Type

None

Examples

Contents


os-ping

Run a ping command from the server to the sepecified device.

Synopsis

os-ping

Description

The ping command is an OS command. All ping options that are available at the OS level are supported. Users should be able to enter any host name or address. The behavior is that it simply passes the string to the OS, executes it as a command and returns the results of the executed command.

Return Type

None

Examples

Contents


passwd

Change current user's password.

Synopsis

passwd -oldpwd <your old password> -newpwd <your new password>

Description

Causes the current user's password to be changed.

Return Type

STATUS

Examples

Contents


pause polling

Stop polling.

Synopsis

pause polling

Description

Stop polling devices for configuration changes.

Return Type

STATUS

Examples

Contents


ping

Run a ping command on a device.

Synopsis

ping -source <IP address | Hostname | Fully Qualified Domain Name> -sourcegroup <Groupname> -dest <List of IP addresses> -rep <Task repeat period> -async -start <task start date> -priority <Task priority>

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.

Return Type

String

Examples

Contents


port scan

Performs a port scan against a device

Synopsis

port scan -deviceip <Device IP address> -deviceid <Device ID> [-start <Task start date>] [-rep <Task repeat period>] [-sync <true or false>] [-priority <Task priority>] [-taskname <Task name>]

Description

Return Type

String

Examples

Contents


provision device

Schedule a provision device task

Synopsis

provision device -ip <IP address> -templateid <Device Template ID> -priority <Task priority> [-name <A used defined name for the task>] [-start <Task start date>] [-variables <Variable List>] [-ignorevariables] [-comment <Comment>] [-duration <Duration>] [-sessionlog <true or false>] [-presnapshot <true or false>] [-postsnapshot <true, false or task>] [-retryCount <Retry count>] [-retryInterval <Retry interval>] [-nocompliance] [-setactive] [-copydata] [-rep <Task repeat period>] [-taskname <Task name>]

Description

Return Type

String

Examples

Contents


quit

Exit the system.

Synopsis

quit

Description

Exit the the system.

Return Type

None

Examples

Contents


release resource id

Release a previously acquired resource identity.

Synopsis

release resource id -id <ID>

Description

Release a previously acquired resource identity.

Return Type

String

Examples

Contents


reload content

Synopsis

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. Note that the policies are imported only if you are using the HP Network Automation Software Ultimate edition license.

Return Type

STATUS

Examples

Contents


reload drivers

Synopsis

reload drivers -force

Description

Causes the server to reload all installed driver files.

Return Type

STATUS

Examples

Contents


reload plugins

Synopsis

reload plugins

Description

Reload any code plugins (such as the topology plugin) that may have been updated while the server was running.

Return Type

STATUS

Examples

Contents


reload server options

Synopsis

reload server options

Description

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

Return Type

String

Examples

Contents


remove auto remediation script

Remove an auto-remediation script assignment (not the script itself). This command is available only with the HP Network Automation Software Ultimate edition license.

Synopsis

remove auto remediation script -ruleid <Policy Rule ID> -scriptid <Custom Script ID>

Description

It removes the auto-remediation script assignment from a rule identified by rule ID. Note that neither the script nor the policy rule will be deleted from the system; they both will be kept in the system.

Return Type

STATUS

Examples

Contents


resume polling

Resume polling.

Synopsis

resume polling

Description

Resume polling devices for configuration changes.

Return Type

STATUS

Examples

Contents


rlogin

Make an rlogin connection to a device.

Synopsis

rlogin [-override] []

Description

Connect to a device through the system's Proxy Interface via telnet (bypassing single sign-on). If you are connected to a device through a console server, you may hit ctrl-\ to return to the the system shell after logging out of the device.

Return Type

None

Examples

Contents


run advanced script

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

Synopsis

run advanced script [-ip <IP address>] [-host <Hostname>] [-fqdn <Fully Qualified Domain Name>] [-deviceid <Device ID>] [-group <Groupname>] -name <Script Name> [-parameters <Parameters>] [-variables <Variable List>] [-start <Task start date>] [-rep <Task repeat period>] [-sync] [-runmode <Run Mode>] [-stoponfailure <Stop on Failure>] [-nowait] [-comment <Snapshop comment>] [-presnapshot <true or false>] [-postsnapshot <true, false or task>] [-priority <Task priority>] [-sessionlog <true, false>] [-taskname <Task name>]

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.

Return Type

String

Examples

Contents


run checkdb

Check the database for potential conflicts and optionally fix them.

Synopsis

run checkdb [-verbose] [-fix]

Description

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

Return Type

None

Examples

Contents


run command script

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

Synopsis

run command script [-ip <IP address>] [-host <Hostname>] [-fqdn <Fully Qualified Domain Name>] [-deviceid <Device ID>] [-group <Groupname>] -name <Script Name> [-variables <Variable List>] [-linebyline] [-start <Run Mode>] [-rep <Stop on Failure>] [-sync <Task start date>] [-runmode <Task repeat period>] [-stoponfailure] [-nowait] [-comment <Snapshop comment>] [-presnapshot <true or false>] [-postsnapshot <true, false or task>] [-priority <Task priority>] [-sessionlog <true, false>] [-taskname <Task name>]

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.

Return Type

String

Examples

Contents


run diagnostic

Run a diagnostic on a device.

Synopsis

run diagnostic [-ip <IP address>] [-host <Hostname>] [-fqdn <Fully Qualified Domain Name>] [-deviceid <Device ID>] [-group <Group Name>] -diagnostic <Diagnostic Name> [-rep <Task repeat period>] [-start <Task start date>] [-sync] [-nowait] [-runmode <Run Mode>] [-stoponfailure <Stop on Failure>] [-comment <Run script comment>] [-duration <Estimated duration of script task.>] [-sessionlog <true or false>] [-customname <Custom data column name>] [-customvalue <Custom data value>] [-customnames <Custom data column names>] [-customvalues <Custom data values>] [-retryInterval <Retry count>] [-retryCount <Retry interval>] [-priority <Task priority>] [-taskname <Task name>]

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.

Return Type

String

Examples

Contents


run external application

Execute a command.

Synopsis

run external application -app <Command> [-start <Task start date>] [-rep <Task repeat period>] [-sync] [-comment <Comment text>] [-startdir <Directory path>] [-resultfile <File path>] [-errorifnonzero <true or false>] [-priority <Task priority>] [-taskname <Task name>]

Description

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

Return Type

String

Examples

Contents


run gc

Run the garbage collector.

Synopsis

run gc

Description

Recycle unused objects to increase the amount of free memory.

Return Type

String

Examples

Contents


run script

Run a command script on a device.

Synopsis

run script [-ip <IP address>] [-host <Hostname>] [-fqdn <Fully Qualified Domain Name>] [-deviceid <Device ID>] [-group <Group Name>] [-mode <Command Script Mode>] -script <Command Script> [-rep <Task repeat period>] [-start <Task start date>] [-sync] [-runmode <Run Mode>] [-stoponfailure <Stop on Failure>] [-nowait] [-comment <Run script comment>] [-presnapshot <true or false>] [-postsnapshot <true, false or task>] [-disablesessionlogging] [-priority <Task priority>] [-linebyline <true or false>] [-taskname <Task name>]

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.

Return Type

String

Examples

Contents


set core status

set the status of a core

Synopsis

set core status -coreid <Core ID> -status <Status (inactive|active)>

Description

The status can be set to either 'active' or 'inactive'. Setting a core to 'inactive' completely excludes it from the Horizontal Scalability environment. It is recommended to power down inactive cores to reduce energy consumption. The 'standby' and 'normal' options have been deprecated. It is no longer necessary to restart any cores for this change to take effect.

Return Type

String

Examples

Contents


set policy rule logic

set policy rule logic (boolean expression or IF-THEN-ELSE statement). This command is available only with the HP Network Automation Software Ultimate edition license.

Synopsis

set policy rule logic -ruleid <Policy Rule ID> -boolexpr <Boolean Expression or IF-THEN-ELSE Rule Logic>

Description

It must be called to set the rule logic after rule conditions are created, deleted, or desired to be changed. Note that no other API call will change the rule logic.

Return Type

ConfigRuleVO with columns:

Examples

Contents


show access

Display a device access record.

Synopsis

show access -id <Device access record ID>

Description

Return Type

DeviceAccessLogVO with columns:

Examples

Contents


show acl

Show ACL.

Synopsis

show acl -id <Device ACL ID>

Description

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

Return Type

DeviceACLVO with columns:

Examples

Contents


show basicip

Show a BasicIP model.

Synopsis

show basicip [-ip <IP address>] [-host <Hostname>] [-fqdn <Fully Qualified Domain Name>] [-deviceid <Device ID>] [-id <Config ID>]

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.

Return Type

String

Examples

Contents


show cache info

Get information about the cache regions defined in @ProductAbbreviation@.

Synopsis

show cache info [-region <REGION_NAME>] [-id <USE_ID>] [-key <USE_KEY>] [-x <EXTENDED_STATS>]

Description

Display the active cache regions in @ProductAbbreviation@.

Return Type

None

Examples

Contents


show config

Show the contents of a config.

Synopsis

show config -id <Config ID> [-mask]

Description

Return Type

String

Examples

Contents


show configlet

Show the configlet inbetween start and end pattern.

Synopsis

show configlet [-ip <IP address>] [-host <Hostname>] [-fqdn <Fully Qualified Domain Name>] [-deviceid <Device ID>] [-start <Start Block>] [-end <End Block>] [-type <Helper>]

Description

Return Type

String

Examples

Contents


show device

Show a device's properties.

Synopsis

show device [-ip <IP address>] [-host <Hostname>] [-fqdn <Fully Qualified Domain Name>] [-deviceid <Device ID>] [-id <Device ID>] [-nodeuuid <Node Uuid>]

Description

Return Type

Collection:DeviceVO with columns:

Examples

Contents


show device config

Show the config most recently retrieved from the specified device.

Synopsis

show device config [-ip <IP address>] [-host <Hostname>] [-fqdn <Fully Qualified Domain Name>] [-deviceid <Device ID>]

Description

Return Type

String

Examples

Contents


show device credentials

Show the current device credentials.

Synopsis

show device credentials [-ip <IP address>] [-host <Hostname>] [-fqdn <Fully Qualified Domain Name>] [-deviceid <Device ID>] [-protocol <SNMP|CLI>]

Description

The passwords are populated in following algorithm:

  1. If device has a LastAuthentication records, the passwords will be retrieved from that record, otherwise:
  2. If device has device specific passwords defined(on Edit Device page), the device specific passwords will be returned
  3. Otherwise, the first applicable device password rule will be used. The return value may contain some or all of following attributes, depending on the device setting:usernamepasswordenable_passwordread_communitywrite_communitysnmpv3_usersnmpv3_authpasswordsnmpv3_privpassword

Return Type

Map

Examples

Contents


show device family

Show the family classification associated with the specified device.

Synopsis

show device family -ip <IP address>

Description

Return Type

String

Examples

Contents


show device latest diff

Show the difference between two configs most recently retrieved from the specified device.

Synopsis

show device latest diff [-ip <IP address>] [-host <Hostname>] [-fqdn <Fully Qualified Domain Name>] [-deviceid <Device ID>]

Description

Return Type

String

Examples

Contents


show device template

Show a device template's properties.

Synopsis

show device template -templateid <Template Device ID>

Description

Return Type

Collection:DeviceVO with columns:

Examples

Contents


show device template config

Show the config most recently retrieved from the specified device template.

Synopsis

show device template config [-host <Hostname>] [-fqdn <Fully Qualified Domain Name>] [-templateid <Template ID>]

Description

Return Type

String

Examples

Contents


show device template config variables

Show the variables defined in the config for specified device template.

Synopsis

show device template config variables -templateid <Template ID>

Description

Return Type

Collection:CustomVariable

Examples

Contents


show deviceinfo

Show a DeviceInformation model.

Synopsis

show deviceinfo [-ip <IP address>] [-host <Hostname>] [-fqdn <Fully Qualified Domain Name>] [-deviceid <Device ID>] [-id <Config ID>]

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.

Return Type

String

Examples

Contents


show diagnostic

Show a diagnostic's results.

Synopsis

show diagnostic -id <Diagnostic ID>

Description

Return Type

String

Examples

Contents


show driver

Show the driver assigned to a device.

Synopsis

show driver [-ip <IP address>] [-host <Hostname>] [-fqdn <Fully Qualified Domain Name>] [-deviceid <Device ID>]

Description

Return Type

Collection:DriverLookupVO with columns:

Examples

Contents


show event

Display the details of an event. However, with the HP Network Automation Software Premium edition license, using this command, you cannot view the following events:

Synopsis

show event -id <event ID>

Description

Return Type

EventVO with columns:

Examples

Contents


show group

Show all information for a device group.

Synopsis

show group [-name <Group name>] [-id <Group id>]

Description

Return Type

DeviceGroupVO with columns:

Examples

Contents


show icmp

Show an ICMPTest model.

Synopsis

show icmp [-ip <IP address>] [-host <Hostname>] [-fqdn <Fully Qualified Domain Name>] [-deviceid <Device ID>] [-id <Config ID>]

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.

Return Type

String

Examples

Contents


show int

Show a ShowInterfaces diagnostic model.

Synopsis

show int [-ip <IP address>] [-host <Hostname>] [-fqdn <Fully Qualified Domain Name>] [-deviceid <Device ID>] [-id <Config ID>]

Description

Output the raw diagnostic data from the ShowInterfaces model. To see the fully parsed interface values, see the show port command.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.

Return Type

String

Examples

Contents


show ip

Show the properties of a non-primary IP address.

Synopsis

show ip -ipvalue <Value> [-deviceip <Device IP address>] [-ip <IP address>] [-host <Hostname>] [-fqdn <Fully Qualified Domain Name>] [-deviceid <Device ID>]

Description

Return Type

IpVO with columns:

Examples

Contents


show latest access

Show the most recent access record for the specified device.

Synopsis

show latest access [-ip <IP address>] [-host <Hostname>] [-fqdn <Fully Qualified Domain Name>] [-deviceid <Device ID>]

Description

Return Type

DeviceAccessLogVO with columns:

Examples

Contents


show metadata

Show a specific piece of custom data.

Synopsis

show metadata -metadataid <Metadata ID>

Description

Return Type

MetadataVO with columns:

Examples

Contents


show metadata field

Show a custom data field

Synopsis

show metadata field -fieldid <Field ID>

Description

Return Type

MetadataFieldVO with columns:

Examples

Contents


show module

Show a module's properties.

Synopsis

show module -id <Module ID>

Description

Return Type

DeviceModuleVO with columns:

Examples

Contents


show oraclecaseinsensitive

Show case-insensitive search for Oracle is enabled or disabled. See the administration guide for more details.

Synopsis

show oraclecaseinsensitive

Description

Return Type

String

Examples

Contents


show ospfneighbor

Show a ShowOSPFNeighbors model.

Synopsis

show ospfneighbor [-ip <IP address>] [-host <Hostname>] [-fqdn <Fully Qualified Domain Name>] [-deviceid <Device ID>] [-id <Config ID>]

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.

Return Type

String

Examples

Contents


show permission

Display whether or not a user has permissions for a particular resource.

Synopsis

show permission -resource <resource> [-u <username>] [-id <user ID>]

Description

Return Type

String

Examples

Contents


show policy

Shows policy information. This command is available only with the HP Network Automation Software Ultimate edition license.

Synopsis

show policy -id <Policy ID>

Description

Return Type

ConfigPolicyVO with columns:

Examples

Contents


show policy compliance

Shows policies and device compliance states. This command is available only with the HP Network Automation Software Ultimate edition license.

Synopsis

show policy compliance [-policyid <Policy ID>] [-deviceid <Device ID>] [-compliance <Compliance State (in|out|unknown)>]

Description

Return Type

Collection:ConfigPolicyComplianceVO with columns:

Examples

Contents


show policy rule

Shows rule information. This command is available only with the HP Network Automation Software Ultimate edition license.

Synopsis

show policy rule -id <Rule ID>

Description

Return Type

ConfigRuleVO with columns:

Examples

Contents


show polling status

Show the current status of polling.

Synopsis

show polling status

Description

Return Type

String

Examples

Contents


show port

Show a port's properties.

Synopsis

show port -id <Port ID>

Description

Ports are ports and interfaces found on the devices in their configuration or within ancillary commands that detail specifics of the ports and interfaces. The values returned have been processed by the device drivers.

Return Type

DevicePortVO with columns:

Examples

Contents


show resource id

Show resource identity information.

Synopsis

show resource id [-name <Name>] [-poolid <Resource identity pool ID>] [-id <ID>]

Description

Show resource identity information. Resource identity can be identified either by ID or combination of name and resource identity pool ID. If resource identity ID is specified, name and resource pool ID are ignored.

Return Type

VO:ResourceIdentityVO with columns:

Examples

Contents


show resource id custom field data

Show resource identity custom field data.

Synopsis

show resource id custom field data -fielddataid <Custom field data id>

Description

Show resource identity custom field data.

Return Type

VO:ResourceIdentityCustomFieldVO with columns:

Examples

Contents


show resource id pool

Show resource identity pool information.

Synopsis

show resource id pool [-name <Name>] [-site <Site Name>] [-id <ID>]

Description

Show resource identity pool information. Resource identity pool can be identified either by ID or name and site. If ID is specified, name and site are ignored.

Return Type

VO:ResourceIdentityPoolVO with columns:

Examples

Contents


show role

Show all information for a user role.

Synopsis

show role [-name <Role name>] [-id <Role id>]

Description

Return Type

CustomRoleVO with columns:

Examples

Contents


show routing

Display a routing table.

Synopsis

show routing [-ip <IP address>] [-host <Hostname>] [-fqdn <Fully Qualified Domain Name>] [-deviceid <Device ID>] [-id <Routing table ID>]

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.

Return Type

String

Examples

Contents


show rule condition

Shows rule condition information. This command is available only with the HP Network Automation Software Ultimate edition license.

Synopsis

show rule condition -id <Condition ID>

Description

Return Type

RuleConditionVO with columns:

Examples

Contents


show script

Show one command script, advanced script or diagnostic.

Synopsis

show script [-id <Script / Diagnostic ID>] [-name <Script / Diagnostic Name>] [-type <Script / Diagnostic Type>]

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.

Return Type

CustomScriptVO with columns:

Examples

Contents


show server option

Display the setting of a server option

Synopsis

show server option -name <option name> [-default <default value>]

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.

Return Type

String

Examples

Contents


show service type

Shows service types assigned to a device

Synopsis

show service type [-ip <IP Address>] [-deviceid <Device ID>]

Description

Return Type

Collection:DevicePropertyVO with columns:

Examples

Contents


show session

Show interceptor log record.

Synopsis

show session -id <Interceptor log id>

Description

Return Type

InterceptorLogVO with columns:

Examples

Contents


show session commands

List all commands in interceptor log record.

Synopsis

show session commands -id <Interceptor log id>

Description

Return Type

String

Examples

Contents


show snapshot

Show the config most recently retrieved from the specified device.

Synopsis

show snapshot [-ip <IP address>] [-host <Hostname>] [-fqdn <Fully Qualified Domain Name>] [-deviceid <Device ID>]

Description

Return Type

String

Examples

Contents


show system message

Display the details of a system message.

Synopsis

show system message -id <System message ID>

Description

Return Type

EventVO with columns:

Examples

Contents


show task

Shows detailed information about a task. However, with the HP Network Automation Software Premium edition license, you cannot view the 'Check Policy Compliance' tasks using this command.

Synopsis

show task -id <Task ID>

Description

Return Type

ScheduleTaskVO with columns:

Examples

Contents


show topology

Show details for a single topology record.

Synopsis

show topology -id <Topology Data ID>

Description

Return Type

DeviceTopologyDataVO with columns:

Examples

Contents


show user

Show all information for a user.

Synopsis

show user [-u <User name>] [-id <User id>]

Description

Return Type

UserVO with columns:

Examples

Contents


show user group

Show all information for a user group.

Synopsis

show user group [-name <Group name>] [-id <Group id>]

Description

Return Type

Object

Examples

Contents


show version

Synopsis

show version

Description

Display the release version of @ProductAbbreviation@.

Return Type

String

Examples

Contents


show vlan

Shows Vlan information for a given Vlan ID for a device

Synopsis

show vlan [-deviceip <Device IP address>] [-ip <IP address>] [-host <Hostname>] [-fqdn <Fully Qualified Domain Name>] [-deviceid <Device ID>] -vlanid <Vlan ID>

Description

Return Type

DeviceVlanInfoVO with columns:

Examples

Contents


show vtp

Shows VTP information for a specific device

Synopsis

show vtp [-deviceip <Device IP address>] [-ip <IP address>] [-host <Hostname>] [-fqdn <Fully Qualified Domain Name>] [-deviceid <Device ID>]

Description

Return Type

DeviceVTPVO with columns:

Examples

Contents


snmp get

Run the SNMP GET command on the specified device and return the received value.

Synopsis

snmp get -deviceid <Device ID> -oid <SNMP OID> [-readwrite <true|false>] [-timeout <timeout>]

Description

This command issues an SNMP GET command to the specified device.

Return Type

String

Examples

Contents


snmp set

Run the SNMP SET command on the specified device.

Synopsis

snmp set -deviceid <Device ID> -oid <SNMP OID> -value <new value> [-readwrite <true|false>] [-timeout <timeout>]

Description

Return Type

String

Examples

Contents


source

Have the the system client execute all commands contained within a text file.

Synopsis

source

Description

This command has no options but takes one argument: the name of the file to "source". The source file should contain only valid CLI commands each separated by one newline.

Return Type

None

Examples

Contents


ssh

Make an ssh connection to a device.

Synopsis

ssh [-override] []

Description

Connect to a device through the system's Proxy Interface via ssh (bypassing single sign-on). If you are connected to a device through a console server, you may hit ctrl-\ to return to the the system shell after logging out of the device.

Return Type

None

Examples

Contents


stop task

Stop a running task.

Synopsis

stop task -id <Task ID>

Description

Return Type

String

Examples

Contents


stop task all

Stop all Running and Waiting tasks.

Synopsis

stop task all

Description

Return Type

String

Examples

Contents


synchronize

Synchronize a device's startup and running configs.

Synopsis

synchronize [-ip <IP address>] [-host <Hostname>] [-fqdn <Fully Qualified Domain Name>] [-deviceid <Device ID>] [-group <Group Name>] [-skipinsync <true|false>] [-rep <Task repeat period>] [-start <Task start date>] [-sync] [-runmode <Run Mode>] [-stoponfailure <Stop on Failure>] [-comment <Task comment>] [-priority <Task priority values>] [-taskname <Task name>]

Description

Synchronize a device's startup configuration so it matches its running configuration. The synchronize operation is actually a scheduled task.

Return Type

String

Examples

Contents


telnet

Make a telnet connection to a device.

Synopsis

telnet [-override] []

Description

Connect to a device through the system's Proxy Interface via telnet (bypassing single sign-on). If you are connected to a device through a console server, you may hit ctrl-\ to return to the the system shell after logging out of the device.

Return Type

None

Examples

Contents


test config

Test policy compliance for a device configuration script. This command is available only with the HP Network Automation Software Ultimate edition license.

Synopsis

test config [-family <Device Family>] -script <Configuration Script> [-policy <Policy Name>] [-group <Device Group>] [-device <Device Name or Device IP address>]

Description

Return Type

String

Examples

Contents


test software

Test software levels for a device or device group. This command is available only with the HP Network Automation Software Ultimate edition license.

Synopsis

test software [-ip <IP Address>] [-group <Device Group>]

Description

Return Type

String

Examples

Contents


traceroute

Run a traceroute command on a device.

Synopsis

traceroute -source <IP address | Hostname | Fully Qualified Domain Name> -sourcegroup <Group name> -dest <List of devices> -rep <Task repeat period> -async -start <task start date> -priority <Task priority values>

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.

Return Type

String

Examples

Contents


undeploy image

undeploy software images from device

Synopsis

undeploy image -ip <device ip address> -images <images separated by ,> [-reboot <reboot instruction>] [-rebootwait <reboot wait (in seconds)>] [-filesystem <file system of device>] [-pretask <task to run before delete>] [-posttask <task to run after delete>] [-start <Task start date>] [-comment <Snapshot comment>] [-duration <Estimated duration of snapshot task.>] [-sessionlog <true or false>] [-customname <Custom data column name>] [-customvalue <Custom data value>] [-customnames <Custom data column names>] [-customvalues <Custom data values>] [-retryInterval <Retry count>] [-retryCount <Retry interval>] [-priority <Task priority values>] [-taskname <Task name>]

Description

delete software images from device.

Return Type

String

Examples

Contents


update dynamic group

Update dynamic group's member devices.

Synopsis

update dynamic group -name <Group name>

Description

Recalculate a dynamic group's member devices based on the predefined criteria. This has no effect on a non-dynamic device group.

Return Type

STATUS

Examples

Contents


version

Display the system version.

Synopsis

version

Description

Displays the system version build number.

Return Type

None

Examples

Contents


© Copyright 2001-2015 Hewlett-Packard Development Company, L.P.