The object_path identifies the object that the command is to operate on. Not all commands require an object path. If the command requires an object path and it is omitted then the current object is assumed as the path.

Note that the link and unlink commands operate on two objects, a parent and a child, so the paths of both objects must be specified.

The object_path can take one of three forms:

• An absolute object path, starting with the root object. The ‘/' character given at the start of the path indicates the root object. For example:

  /System:"System"/EventSubscription:"DeviceFaults"
  

• A relative object path from the current object. For example:

  network:"Acme"/device:"Cisco7505"
  

• An object's unique ID number, enclosed in square brackets. For example:

  [675]
  

Table 2-1 shows and defines the symbols that may be used in the path definition.

CommandExecutionError.ERR_ObjectModelViolation: Object [1802], a Interface, has multiple children of type SubInterface with the same name: Serial1/0.100, [4129].

Not all commands require attributes. When set, they take the form:

attribute="value"

Quotation marks are not strictly required unless there are spaces within the value. If necessary, multiple attributes can be specified on a single line.

Attributes entered in command lines can be one of the data types displayed in Table 2-2.

Commands and parameters are not case-sensitive, with the exception of user passwords which must be entered exactly as originally set.

The login command logs the user into the system, using a log-in name and password previously set up in IP Service Activator. You can use the login command in scripts to execute commands on the OIM client without logging into it. The log in information is provided in these scripts.

Table 2-4 lists the attributes for the login command.

The syntax for the login command is:

login name=username password=password

where username and password are the log-in name and password previously set up in IP Service Activator.

For example:

login name="user1" password="mypass26"

[no default]

The LoginException error may be returned for the following reasons:

• The user has entered an invalid combination of username and password.

• The user has repeatedly failed to log into the system.

• Concurrent logins are not permitted.

• The password has expired.

The changePassword command enables the user to set or modify their own password.

The syntax for the changePassword command is:

changepassword

The user is prompted to enter a password and to confirm it. Any characters entered are displayed on screen in encrypted mode.

For example:

changepassword
password: *******
confirmation password: *******

[no default]

[no default]

[no default]

The logout command logs the user off the system.

The syntax for the logout command is:

logout

[no default]

[no default]

[no default]

The getAccess command returns the current user's access permissions for a single object, an object type or all object types.

Table 2-5 lists the attributes for the getAccess command.

The syntax for the getAccess command is:

getAccess [object-path] [type=objecttype]

where object-path is the path to object for which access rights are required and objecttype is an object type name. Use all instead of an object type name to retreive information for all object types.

For example:

• To return access rights for the current object:

  getAccess
  

• To return access rights for the object with ID no 250:

  getAccess [250]
  

• To return access rights for all Device objects:

  getAccess type=Device
  

• To return access rights for all objects:

  getAccess type=all

The object for which access rights are required. This is ignored if a type attribute is specified.

The getAccess command returns a True or False value for each of the following access rights:

• read

• create (includes delete)

• link (includes unlink)

• modify

• execute

[no default]

The abort command stops the current transaction and discards the queued commands.

The syntax for the abort command is:

abort

[no default]

[no default]

[no default]

The commit command saves the changes within the current transaction in the object model, and sends them to the server.

A transaction can be:

• Committed immediately. The common object model is updated with the transaction's changes and any configuration changes are propagated to the network.

• Queued. The transaction is saved to the common object model's transaction store with a status of Pending. The object model changes associated with that transaction are not executed and no configuration changes are propagated to the network.

• Scheduled. The transaction is saved and will be committed at a specified future date or time.

In all cases, the commit command creates a TransactionEntry object.

Atomic transactions change the model for successful execution of the transaction. Normally, all commands in a transaction must be executed successfully for the transaction as a whole to be completed i.e. if any one command in a transaction fails, the entire transaction fails.

Use atomic transactions to break a transaction into smaller sub-transactions which can succeed or fail independently without causing the entire transaction to fail.

These sub-transactions are grouped using the commit type atomic. Then entire transaction, which includes the atomic sub-transactions, is then committed using the commit type atomicTransaction.

Notice the error in the first command of the following example:

create Customre:"Bob"
create Customer:"Bob"/Site:"NOC"
commit mode=atomic
create Customer:"John Doe"
create Customer:"John Doe"/Site:"NOC"
commit mode=atomic
commit mode=atomicTransaction

The first command fails, causing the first atomic transaction, which attempts to create customer Bob, to fail. However, the second atomic transaction to create customer John Doe and its NOC succeeds. The post transaction activities which apply to the second atomic transaction are still completed.

If a command in a transaction fails, and it isn't in an atomic transaction, the whole transaction fails, regardless of whether or not it contained atomic transactions.

Table 2-7 describes the attributes used by the commit command.

The syntax for the commit command is:

commit [mode=commit-mode] [name=transaction-name] [schedule=datetime]

For example:

• To commit the current transaction:

  commit
  

• To schedule the current transaction to be executed at a specific time:

  commit mode=schedule name="Scheduled Transaction" schedule="2002/11/15 20:00:00"
  

• To queue a current transaction:

  commit mode=queue name="createVPN"

[no default]

[no default]

The CommandExecutionError may be returned for the following reasons:

• Commit Failure: an element of the commit transaction was not successful

• No name attribute was specified to a queued or scheduled transaction

• No schedule time was specified for a scheduled transaction

The events command returns the changes that have occurred (through transactions) since the last time the events command was called.

The OIM starts to record events when the events command is first entered. When the events command is next called all the recorded events are returned.

The command can be used in two ways:

• If no path is specified, the command lists the changes that have occurred since the last time the command was called.

• If a path is specified, the command lists the transactions within the identified transaction object.

Table 2-8 lists the attributes for the events command.

The syntax for the events command is:

events [object-path] [block=true]

For example:

• To return information about a committed transaction:

  events [2037]
  

• To run the events command in blocking mode, in order to pause the execution of the command until an event occurs:

  events block=true
  

The path to the TransactionEntry object. A path does not have to be specified.

The events command returns the commands within the committed transaction.

• The CommandExecutionError may be returned if the object specified in the path is not a TransactionEntry object.

• The OimSystemException command may be returned if the OIM session is invalid, or if OIM is shutting down.

The exporttransaction command outputs the list of operations part of the transaction. The output is formatted as follows for three formats of output: normal, concrete and fault operations:

OID: <main_object_ID>      OClass: <main_object_class_type>    OName: <main_object_name> Operation: <type_of_operation>       PClass: <parent_object_class>        PName: <parent_object_name> PId: <parent_object_id>    Parameters: <Attribute1=Value1>, <Attribute2=Value2>…
CID: <concrete_ID>      CClass: <Concrete_object_class_type>     Operation:  <type_of_operation>     PClass:      PName:  PId:    Parameters:  <Attibute1=Value1>…
Fault Operations:
FID: <object_ID>      Operation: <type_of_operation>       PClass:         PName:  PId:    Parameters: <Attribute1=Value1>, <Attribute2=Value2>…

The syntax for the exporttransaction command is:

exporttransaction [TransactionEntry-object-id]

where TransactionEntry-object-id is the object ID for which the list of operations is to be displayed.

[no default]

The exporttransaction command returns a list of operations for the transaction.

• Transaction entry ID not specified:

  CommandExecutionError.ERR_ExportTransIdRequired: The command needs a transaction entry id.

• Transaction entry not found:

  CommandExecutionError.ERR_CannotResolveToObject: Cannot Resolve to object: [<object_id>]

The listTrans command lists all the commands entered in the current transaction.

Note that if you run listTrans command just after committing a set of commands, listTrans returns nothing.

The syntax for the listTrans command is:

listTrans

[no default]

The listTrans command returns the list of commands in the format:

command object-id [object-id] parameters

For example:

create /policy:"policy"/domain:"d"/customer:"YDEurope"

[no default]

The merge command merges the content of an existing TransactionEntry object to the current local object model. For queued (Pending) transactions, this is required before the transaction can be committed.

During the merge, IP Service Activator tests the validity of the transaction against the local object model. If there is a conflict, IP Service Activator abandons the merge and reports an error. This occurs, for example, if you attempt to merge a transaction that creates an object that already exists.

Merge is a queued command, that is, it is not executed immediately like the other Transaction Module commands.

The syntax for the merge command is:

merge [object-path]

For example, to merge the transaction MyQueuedChanges with the local object model:

merge /System:"System"/TransactionEntry:"MyQueuedChanges" 

The path of the TransactionEntry object to be merged. If no path is given, the current object is assumed.

[no default]

The CommandExecutionError may be returned for the following reasons:

• The object specified in the path is not a TransactionEntry object

• The transaction in the TransactionEntry object could not be merged with the local object model.

The rollback command rolls back the changes specified in a TransactionEntry object from the current object model.

When you roll back a transaction, its changes are removed from the object model and, where configuration has been installed on network devices, the configuration is removed.

The ability to roll back a committed transaction depends on whether transactions that were subsequently committed are dependent on that transaction's changes. For example, a transaction that created a VPN to which sites and interfaces have subsequently been linked cannot be rolled back. It is not necessary to have merged the content of the TransactionEntry object first.

Rollback is a queued command, that is, it is not executed immediately like the other Transaction Module commands.

The syntax for the rollback command is:

rollback [object-path]

For example:

rollback /System:"System"/TransactionEntry:"MyQueuedChanges"

The path of the TransactionEntry object to be rolled back. If no path is given, the current object is assumed.

[no default]

The CommandExecutionError may be returned for the following reasons:

• The object specified in the path is not a TransactionEntry object

• The transaction stored in the TransactionEntry object could not be rolled back in the local object model.

The schedule command changes a queued (Pending) TransactionEntry object into a scheduled one, or changes the scheduled time for a scheduled TransactionEntry object.

Schedule is a queued command; that is, it is not executed immediately like the other Transaction Module commands.

Table 2-9 lists the attributes for the schedule command.

The syntax for the schedule command is:

schedule [object-path] schedule=schedule-date

For example:

schedule TransactionEntry:"MyQueuedChanges" schedule="2001/6/15 20:00:00"

The path to the TransactionEntry object to be scheduled. If no path is given, the current object is assumed.

[no default]

The CommandExecutionError may be returned for the following reasons:

• The object specified in the path is not a TransactionEntry object

• The TransactionEntry object's state is not Pending or Scheduled.

The PreserveMissingInterfaces command restores the interfaces which are 'not found' to a ‘found' state. Neither the GUI nor the OSS Integration Manager Interface allow you to manage a device with ‘not found' interfaces. These have to either be discovered to be found or must be deleted individually. For more information on preserving missing interfaces, see the IP Service Activator online Help.

The syntax for the PreserveMissingInterfaces command is:

preservemissinginterfaces object_id

where object_id is the identifier for the device, interface, or sub-interface.

For example:

Policy:"Policy"/Domain:"Oracle_Corporation"/Network:"Oracle_Corporation">ls
[3773] ParameterSetInstance:""
[3701] Device:"rot7507-4"
/Policy:"Policy"/Domain:"Oracle_Corporation"/Network:"Oracle_Corporation">preservemissinginterfaces [3701]

The path should be mentioned with device object_id separated by a space.

[no default]

CommandExecutionError.ERR_CommitFailure: Commit failed on command 1 preservemissinginterfaces

CommandExecutionError.ERR_IncorrectObjectForCommand: The command PreserveMissingInterfaces may not be applied to a Network

The ApplyRoleAssignmentRules command applies role assignment rules to devices and interfaces in the current network.

The syntax for the ApplyRoleAssignmentRules command is:

ApplyRoleAssignmentRules

For example:

cd /Policy:"Policy"/Domain:"MyDomain"/Network:"MyDomain"
ApplyRoleAssignmentRules
commit

None, as the command is applied to the current path.

[no default]

If applied at objects other than a Network object, you will receive the following error or a similar error:

CommandExecutionError.ERR_IncorrectObjectForCommand: The command ApplyRoleAssignmentRules may not be applied to a Domain.

The copy command creates a copy of the object and of its direct children, and links the newly-created object to a specified parent.

The syntax for the copy command is:

copy source-object-path dest-object-path

where source-object-path is the path to the source object and dest-object-path is the path to the desired destination.

For example, to copy a rule from one point in the topology to another:

copy domain:"europe"/Customer/RuleClassification:"CustomerRule" domain:"europe"/Network:"England"/RuleClassification:"NetRule"

Paths for both source and destination objects must be provided. They must be separated by a space.

[no default]

[no default]

The create command creates and names a new object. If attributes can be defined they override the default attribute settings.

The object is linked to the parent object indicated in the path statement.

The syntax for the create command is:

create object-path [attributes]

where attributes is an optional list of attribute=value pairs which override the default attributes or supply required attributes.

For example, to create a new customer called Acme Telecom in the Europe domain:

create Domain:"europe"/Customer:"Acme Telecom" Remarks="Important Customer" 

create Customer:foo Remarks="A Customer" Reference="A Reference"

create Customer:foo
Modify Customer:foo Remarks="A Customer" Reference="A Reference"

create Device:"NLV2000" IsVirtual=False DeviceType:"Cisco2000"

The path to the new object, ending with the type and name of the object to be created.

[no default]

The CommandExecutionError may be returned for the following reasons:

• The user does not have permission to perform this command

• The object cannot be created at this position

The delete command removes a specified object. All children of the object are unlinked, and any orphaned children are deleted.

The syntax for the delete command is:

delete object-path 

For example:

• To delete a customer called Acme Telecom in the Europe domain:

  delete Domain:"europe"/Customer:"Acme Telecom"
  

• To delete the object with an ID of 400:

  delete [400]

The path of the object to be deleted or its ID.

[no default]

The CommandExecutionError may be returned for the following reasons:

• The user does not have permission to perform this command.

The link command links two objects in a parent/child relationship. The parent and child objects to be linked are specified in the path.

The syntax for the link command is:

link parent-object-path child-object-path

where parent-object-path is the path or object ID for the object becoming the parent and child-object-path is the path or object ID for the object becoming the child.

For example:

• To link a child object with ID 475 to a parent object with ID 600:

  link [600] [475]
  

• To link the site “Paris" to the customer “Acme Telecom":

  link customer:"Acme Telecom" site:"Paris"

Paths for both parent and child objects must be provided. They must be separated by a space.

[no default]

The CommandExecutionError may be returned for the following reasons:

• The object types indicated cannot be linked

• The user does not have permission to perform this command

• The child object is already a child of the parent

The unlink command unlinks a specified child object from its parent object.

The syntax for the unlink command is:

unlink parent-object-path child-object-path

where parent-object-path is the path or object ID for the parent object being unlinked and child-object-path is the path or object ID for the child object being unlinked.

For example, to unlink a child object with ID 400 from a parent object with ID 300:

unlink [300] [400]

Paths for both parent and child objects must be provided. They must be separated by a space.

[no default]

The CommandExecutionError may be returned for the following reasons:

• The object types indicated cannot be unlinked

• The two objects indicated are not linked

The modify command modifies the attributes of the specified object.

The syntax for the modify command is:

modify object-path parameters

where parameters is a list of attribute=value pairs which overrides the default attributes.

Attributes may be listed in any order.

For example, to change the comment and name attributes of an object with ID 200.

modify [200] comment="this is a comment" name=NewName

Path of the object to be modified or its object ID.

[no default]

An error in one attribute results in all attributes being rejected.

The CommandExecutionError may be returned for the following reasons:

• The object or attributes are read only

• The named attribute does not exist on the object

The subscribe/unsubscribe commands can be used to ignore certain types of objects during the lifetime of a session. For example:

• They can be used when browsing through the EOM using the CLI, to reduce the amount of information displayed on screen. For example, policy elements or topology elements can be hidden.

• They can be used if you want to run xmlExport for specific objects only.

• They can be used when waiting for a transaction to happen (events block=true), but you want to report on certain objects only, such as ConcreteObjects.

• They can be used to preserve backward compatibility. Certain types can be shown or hidden that were not available in previous versions of OIM.

Table 2-11 lists the attributes for the subscribe/unsubscribe command.

The syntax for the subscribe/unsubscribe commands is:

subscribe type={object-type|all}
unsubscribe type={object-type|all}
commit

[no default]

[no default]

A common query is to wait for policy elements to be applied in the policy server. For example, if you commit a transaction that creates an access rule, you may want to be notified only when the concrete rule objects are created:

create RuleAccess:myRule
unsubscribe type=all 
subscribe type=ConcreteObject
subscribe type=System 
commit
events block=true

This makes sure that only events concerning concrete objects are reported. For more information on events command, see "The Events Command".

The use command indicates the use of a policy element (such as a PHB group) by a policy target (such as a device). This is achieved by creating an intermediary Instance object.

For example, a target can be configured to use a PHB group by creating a PHBGroupInstance object, which is the child of both the target object and the PHBGroup object.

At present, this command is used only for associating PHB groups and ParameterSetInstance objects with target objects.

Attributes are applied to the Instance object. See "The GetParameters Command".

The syntax for the use command is:

use target-object-path policy-element-path [attributes]

For example, to specify that the PHB Group “WRR" is applied to the XYZ network:

use network:"XYZNetwork" PHBGroup:"WRR" 

This creates a PHBGroupInstance object, child of both the XYZNetwork network and the WRR PHB group.

The target-object-path is the path of the policy target object that is to use the policy element and policy-element-path is the path of the policy element object to be used.

Both paths must be specified separated by a space.

[no default]

The CommandExecutionError may be returned for the following reasons:

• One of the object types indicated cannot be a target, or cannot be applied

The unuse command removes the link between a policy element by a policy target by destroying the Instance object created by the use command.

The syntax for the use command is:

unuse target-object-path policy-element-path

For example, to specify that the PHB Group “WRR" is no longer applied to the XYZ network:

unuse network:"XYZNetwork" PHBGroup:"WRR" 

The target-object-path is the path of the policy target object that is using the policy element and policy-element-path is the path of the policy element object used.

[no default]

The CommandExecutionError may be returned for the following reasons:

• The object type indicated cannot be unused

The discover command begins a discovery operation. The discover command can be used to discover specific devices in the physical network and create new device objects to represent them, or to get the attributes of an existing device object from the physical device.

The discover command can be used in one of two ways:

• An IP address and subnet mask or a DNS name can be given and the corresponding device(s) are found and linked to the network object specified in the path.

• The path of an existing object can be given, and the object is rediscovered and its attributes updated if necessary.

The discover command is executed immediately rather than being queued to a transaction.

The discover command can be applied only to Devices and Networks (as modelled by IP Service Activator).

No attributes are required for parameters for a rediscovery. For a new discovery, where the path is an existing network, attributes are required.

Table 2-13 lists and describes the possible attributes for the discover command.

For more on the discover command, see "Discovering Devices", and for more information on the discovery process, see IP Service Activator User's Guide.

The syntax for the discover command is:

discover object-path [parameters]

For example:

• To discover a device as a child object of the root network, assuming the root network ID has an object ID of 250:

  discover [250] ipaddress=10.0.0.30
  

• To discover all devices on a subnet:

  discover [250] ipaddress=10.20.30.0 mask=24
  

• To discover a device and get the capabilities, using anonymous login:

  discover [250] ipaddress=10.0.0.30 accessstyle=anonymous loginpassword=apasswd enable password=anotherpassword
  

• To discover a device, inheriting security settings from the network object:

  discover policy:"Policy"/domain:"DDTest"/network:"DDTest" ipaddress=192.168.27.1 accessstyle="TACACS" inheritssecurity=True
  

• To rediscover an existing device with the object ID of 500:

  discover [500]
  

• To discover a device using an SNMP Profile:

  discover ipaddress=192.168.27.1 SnmpProfileName=SNMP_profile3

The object-path can be one of two things. For a new discovery, object-path is the path or ID of the object that the already-discovered objects are to be linked to (must be a network object). For a rediscovery, object-path is the path or ID of the object to be rediscovered.

[no default]

The CommandExecutionError may be returned for the following reasons:

• Incorrect combination of attributes.

• Path specified is not a discoverable object or an object a to which a discoverable object can be linked.

The manage command changes the state of the specified object to Managed. This command can only be applied to a Device object.

The syntax for the manage command is:

manage [object-path]

For example, to manage the device with an object ID of 3675:

manage [3675]

The object-path is the path or object ID of the object to be managed.

[no default]

The CommandExecutionError may be returned for the following reasons:

• The specified object is already managed.

• The object cannot be managed.

The unmanage command changes the state of the specified object to Unmanaged. This command can only be applied to a Device object.

The syntax for the unmanage command is:

unmanage [object-path]

For example, to unmanage the current object:

unmanage

The object-path is the path or ID of the object to be unmanaged.

[no default]

The CommandExecutionError may be returned for the following reasons:

• The specified object is already unmanaged.

• The object cannot be managed.

The resetCapability command resets the capabilities discovered for a specific target. This command can only be applied to a Device or Interface object. Ensure that the device is in the unmanaged state before applying the resetCapability command.

After the command is applied, the capability of the target device and its child interfaces or the target Interface are linked to a default (NULL) capability.

The syntax for the resetCapability command is:

resetCapability [object-path]

The object-path is the path or ID of the Device or Interface object to be unmanaged.

[no default]

The CommandExecutionError may be returned for the following reasons:

• The specified object is invalid for this command.

The find command locates an object in the object model and returns its path. The match is made against the object name and/or object attributes.

The search string may contain wildcard tokens, where an asterisk represents any number of characters and a question mark represents a single character.

The search starts at the point specified by the object path and can search up or down the topology tree.

You can use the Depth and Limit attributes to refine the scope of a search.

For more examples of using the find command, see "Finding Objects".

Table 2-15 lists the possible attributes.

The syntax for the find command is:

find [object-path] search-string [attributes]

Values for attributes may be specified to narrow the search. Only objects matching the search string and any specified attributes are returned.

For example:

• To search for interfaces with the name Serial0:

  find . interface:"Serial0"
  

• To search up the tree from the current location for any customer objects:

  find . Customer:"*" finddirection=parent
  

• To search the domain called Acme to find VPN objects starting with the string “Mari" and with an IP address starting with 212:

  find domain:"Acme" "vpn:Mari*" direction=child ipAddress="212*" vpnType=Mesh
  

  returns:

  [276]   vpn:"Marigold"
  [923]   vpn:"Mario" 
  

The object-path is the path or ID of an object. If no path is given, the current object is assumed.

The find command returns a list of all objects that meet the search criteria.

The CommandExecutionError may be returned for the following reasons:

• The MatchConditions are malformed.

• The find command could not return anything. For example, an Object Type used in the command does not exist.

The findParameters command locates an object in the object model that has parameters set to particular values and returns its path. The match is made against the object name and/or object parameters.

Parameters are applied to an object when a ParameterSetInstance object is linked to it or to a parent object from which it inherits.

The search string may contain wildcard tokens, where an asterisk represents any number of characters and a question mark represents a single character.

The search starts at the point specified by the object path and can search up or down the topology tree.

When the findParameters command is run without parameters, it has the same effect as the find command.

Table 2-16 lists the parameters that can be specified along with their corresponding attributes.

The syntax for the findParameters command is:

findParameters [object-path] search-string [parameters]

Values for parameters can be specified to narrow the search. Only objects matching the search string and any specified parameters are returned.

For example, to find all interfaces with the parameter OCH_MeasureCBQos=True:

findParameters / Interface:"*" OCH_MeasureCBQos=True

The object-path is the path or ID of an object. If no path is given, the current object is assumed.

The findParameters command returns a list of all the objects that meet the search criteria.

[no default]

The getAttributes command lists the attributes for a specified object.

The syntax for the getAttributes command is:

getAttributes [object-path]

For example, the command to return the attributes for a selected EventSubscription object:

getAttributes /System:"System"/EventSubscription:"mySubscription"

returns:

    rcw String     Name                = "mySubscription"
    rcw String     Description         = ""
    rcw Boolean    Enable              = True
    rcw Boolean    SendPendingEvents   = False
    rcw Enum       DeliveryType        = SnmpTrap
    rcw String     DeliveryDetails     = ""
    rcw U32        Id                  = 2

The object-path is the path or ID of an object for which the list of attributes is required. If no path is given, the current object is assumed.

The getAttributes command returns a list of attributes for the specified object, including their data type and access rights (r=read, c=create, w=write).

The CommandExecutionError may be returned for the following reasons:

• The object specified is not found

• You do not have permission to view the object

The getChildren command lists all child objects that are linked to the specified object.

The syntax for the getChildren command is:

getchildren [object-path]

For example, to return the children of the current object:

getChildren

returns:

[697]   domain:"zeus" 
[745]   domain:"diana" 
[211]   domain:"Aphrodite" 

The object-path is the path or ID of an object for which the list of children is required. If no path is given, the current object is assumed.

The getChildren command returns a list of children of the specified object, returned as a sequence of objects.

The CommandExecutionError may be returned for the following reasons:

• The object specified is not found

The getID command returns the ID of an object.

The syntax for the getID command is:

getid [object-path]

For example, to return the ID number of the VPN called Executive:

getID /domain:"europe"/customer:"myCustomer"/vpn:"executive"

returns:

[8359]

The object-object path is the path to the object for which the ID is needed. If no path is given, the current object is assumed.

The getID command returns the requested object ID number.

The CommandExecutionError may be returned for the following reasons:

• The object specified is not found

The getName command returns the object name for the specified object.

The syntax for the getName command is:

getName [object-path]

For example:

• To return the name of the parent object:

  getName .. 
  

• To return the name of the object with an ID of 8359:

  getName [8359]
  

  The name is returned in the following format:

  vpn:"executive"

The object-path is the path or ID of the object for which the name is required. If no path is given, the current object is assumed.

The name of the current object.

The CommandExecutionError may be returned for the following reasons:

• The object specified is not found

• You do not have permission to view the object

The getParameters command retrieves a list of parameters that are applied to the target object.

Parameters are applied when "ParameterSetInstance" objects are linked to the object, or to an object higher in the hierarchy. The Levels attribute of the ParameterSetInstance object determines which type of object the parameters are applied to.

Before using the getParameters command, a parameter set must be applied using the use command. Specific values of parameters may be set using the use command, or by modifying the ParameterSetInstance object created. See "The Use Command" for further information.

The syntax for the getParameters command is:

getParameters [object-path]

For example, to apply the parameter set object (ID=15) to a network object (ID=350):

use [350] [15] name="Instance" OCH_NetflowEnabled=True Levels=4

This creates a ParameterSetInstance object with the name "Instance" which is a child of both the Network object specified and the ParameterSet. Only the OCH_NetflowEnabled and Levels attributes are set; other attributes are set to the default value. Levels=4 means that the parameters are applied at the interface level within the specified network.

The ParameterSetInstance object created must then be linked to a DeviceRole and an InterfaceRole. For example, assuming the newly created ParameterSetInstance object has an ID of 555:

link [555] [23]
link [555] [28]

Using getParameters on one of the interfaces with the correct roles shows the applied parameters:

getParameters [2456]

Could return the following:

r-- Boolean     OCH_MeasureCBQoS     = False
r-- Boolean     OCH_MeasureCarQoSMIB = False
r-- Boolean     OCH_MeasureMIB2Stats = False
r-- Boolean     OCH_MeasureNetflowEnabled = False
r-- U32     OCH_NetflowVersion = 1
r-- U32     OCH_NetflowAggregation = 0
r-- U32     OCH_NetflowCacheSize = 0
r-- U32     OCH_NetflowTimeoutActive = 0
r-- U32     OCH_NetflowTimeoutInactive = 0

The object-path is the path or ID of the object for which the list or parameters is required.

Returns the parameters that are applied to the specified target object.

The CommandExecutionError may be returned for the following reasons:

• The object specified is not found

• You do not have permission to view the object

The getParents command lists all the parents of the specified object.

The syntax for the getParents command is:

getparents [object-path]

For example, to list the parents of the object with an ID of 8349:

getParents [8349]

The details are returned in the following format:

[653]   domain:"europe"

The object-path is the path or ID of the object for which the list of parents is required. If no path is given, the current object is assumed.

The getParents command returns the list of all parents of the specified objects as a sequence of objects.

The CommandExecutionError may be returned for the following reasons:

• The object specified is not found

• You do not have permission to view the object

The getPath command returns the path to a given object ID or the current position in the object hierarchy.

Table 2-17 lists the possible attribute.

The syntax for the getPath command is:

getPath [object-path]

For example, to return the path of the current object:

getPath

The details are returned in the following format:

/domain:"europe"/customer:"myCustomer"/vpn:"executive" 

The object-path is the ID of the object for which the path is required. If no value is given, the current object is assumed.

The getPath command returns the current path, or the path to the given object. If an object ID was given that is in the current path or is a child of the current object, then the path returned is constructed from the current path.

If any other ID is given and there is more than one possible path to the object then a path is selected arbitrarily from the set of possible paths.

The CommandExecutionError may be returned for the following reasons:

• The object specified is not found

• You do not have permission to view the object

The setPath command sets the current path within the object hierarchy.

The syntax for the setPath command is:

setPath [object-path]

For example, to set the path to the "Executive" VPN:

setPath customer:"myCustomer"/vpn:"executive"

returns:

/domain:"europe"/customer:"myCustomer"/vpn:"executive" 

The object-path is the path or ID of the object for which the path is to be set. Table Table 2-18 shows the symbols that may be used in the path.

Returns the current path.

The CommandExecutionError may be returned for the following reasons:

• The object specified is not found

• You do not have permission to view the object

The getTargets command retrieves the targets that a ParameterSetInstance object applies to. A ParameterSetInstance is applied to a parent object, but the parameters may be applied to other objects.

For example, if you link a ParameterSetInstance to a Network object, it would not be applied to the Network object, but to devices or interfaces that inherit from the Network object. (The usual rules of inheritance apply.) The getTargets command returns a list of those objects the ParameterSetInstance applies to.

For more information, see "Applying Parameter Sets".

The syntax for the getTargets command is:

getTargets [object-path]

For example, to return a list of the interfaces where the ParameterSetInstance object has been applied:

getTargets [2380]

returns:

[302] Interface: "Ethernet1"
[318] Interface: "Ethernet2"

The object-path is the path or ID of the ParameterSetInstance object for which the targets are required.

[no default]

The CommandExecutionError may be returned for the following reasons:

• The object specified is not found

• You do not have permission to view the object

The xmlExport command outputs the external object model from the target object in XML format. The output is formatted as follows:

<ObjectType attribute1="value1" attribute2="value2"...>
<ObjectType attribute1="value1" attribute2="value2"...>
<ObjectType attribute1="value1" attribute2="value2"...>
</ObjectType>

If the object has children, they are shown further indented and the </ObjectType> closes the definition.

If the object has no children, the tag takes the form <ObjectType attributes.../>

The syntax for the xmlExport command is:

xmlExport [object-path] [xmlEscape=boolean-value] [compress=boolean-value]

For example, assuming the object with an ID of 400 is a domain:

xmlExport [400] xmlEscape=true

might return:

<Domain Id="400" name"Europe">
<Customer Id="500" Name="Cust1" Remarks="A customer">
<Site Id="600" Name="Site1"/>
</Customer>
</Customer Id="700" Name="Cust2"/>
</Domain>

In this example, the domain (ID=400) has two children which are both customers. One customer (ID=500) has a child (a site), but the other customer (ID=700) does not.

The object-path is the path or ID of an object. If no path is given, the current object is assumed.

The xmlExport command returns details of all objects below the target object in the hierarchy in XML format.

The CommandExecutionError may be returned for the following reasons:

• The object specified is not found

• You do not have permission to view the object

The alias command defines an alias for a particular command. This allows you to use an alternative or a short form of a command if you prefer.

Aliases apply only to the current session; they are removed when the session terminates.

The syntax for the alias command is:

alias [alias=command]

where alias is the alias to be used and command is the existing command for which the alias is to be used. If no parameters are entered, the alias command returns all current aliases.

For example:

• To set up the alias “cd" to be used as an alternative to the setPath command:

  alias cd=setpath
  

• To list all current aliases:

  alias

[no default]

[no default]

[no default]