Topology Extended Commands

There are nine extended commands for managing topology.

Topology Command Parameters

The following parameters can be used by the extended commands for topology. For details about the a, columns, f, and t parameters, refer to Predefined Parameters and Flags.

agentPort

The value of the agentPort parameter is the agent port number. If agentPort is not specified, the default value of 161 is used. The agentPort parameter is optional. This parameter is only specified if the url parameter is not specified and if you do not want the default port.

arch

The value of the arch parameter is the architecture of the topology object.

domain

The value of the domain parameter is the name of the Sun Management Center domain that you must specify for the setCurrentDomain command.

family

The value of the family parameter is the object family of the topology object.

fullDesc

The value of the fullDesc parameter is a text description of the entity or group being created.

isPolled

The value of the isPolled parameter can be true or false. If the value is true, the entity polls for status information according to the polling type (pollType).

pollType

The value of the pollType parameter is the type of polling for this entity. The following values are allowed for the pollType parameter:

• ahost – Identifies a host on which an active agent is installed and running

• amod – Identifies a module that has an active agent

• aprox – Identifies an agent that is running an SNMP proxy module

• dummy – Identifies a device that is not monitored

• ping – Identifies a host to be monitored using the ICMP ping command

• snmp — Identifies a host to be monitored using the SNMP ping command

readInfo

The value of the readInfo parameter is the name of the SNMPv1 read community for SNMP polled objects.

targetHost

The value of the targetHost parameter is the name of the target host.

targetIp

The value of the targetIP parameter is the IP address of the target host.

topoCfg

The value of the topoCfg parameter is configuration information for the topological representation of a managed entity.

topoType

The value of the topoType parameter is the topological representation type of a managed entity.

url

The value of the url parameter is the URL of the entity to be polled. The value of the url parameter can be specified in the following formats:

ping://hostname
snmp://hostname:port/oid/#.#.#.#
snmp://hostname:port/[mod,sym]/path

writeInfo

The value of the writeInfo parameter is the name of the SNMPv1 write community for SNMP polled objects.

Topology Commands

There are nine extended commands for managing topology.

createEntity

The createEntity command creates a managed entity. Properties of the managed entity are specified with the following parameters: agentPort, arch, family, fullDesc, isPolled, pollType, readInfo, targetHost, targetIP, topoCfg, topoType, url, columns, f, and t.

If the url or agentPort parameters are specified, the default port of 161 is not used.

createGroup

The createGroup command creates a topology domain or group. If the entity being created is a group, the group properties are specified with the following parameters: family and fullDesc. The createGroup command also takes the following parameters: columns, f, and t.

If the entity being created is a domain, the family and fullDesc parameters are ignored.

delTopoObjects

The delTopoObjects command deletes a managed topology object in the managed topology hierarchy. All objects under the specified topology object are deleted as well. The delTopoObjects command takes the following parameters: columns, f, and t.

getAgentPort

The getAgentPort command returns a port number of the Sun Management Center agent running on the specified host in a topology domain. If there are multiple agents, a list of port numbers is returned. The getAgentPort command takes the following parameters: columns, f, and t.

If t is not specified, the default domain is used.

getAllTopoObjects

The getAllTopoObjects command returns a list of all managed objects in the managed topology hierarchy that satisfy conditions specified by the arch, family, or pollType parameters. The getAllTopoObjects command also takes the following parameters: columns, f, and t.

getCurrentDomain

The getCurrentDomain command returns the name of the current domain.

getDomains

The getDomains command returns a list of all managed domains.

getTopoObject

The getTopoObject command returns a list of managed topology objects directly under the topology object specified by parameter t that satisfy conditions specified by the arch, family, or pollType parameters. The getTopoObject command also takes the following parameters: columns and f.

setCurrentDomain

The setCurrentDomain command sets the home domain to the value specified in the domain parameter.

For information about exporting and importing topology information from the CLI, see Import and Export CLI Interface.

Topology Command Examples

The following command returns a list of all Sun Management Center agent hosts on the sun4u family in group building12 in the menlo_park domain that are running SunOS 5.7 software:

> getTopoObject t=/menlo_park/building12 pollType=ahost \
arch="SunOS 5.7" family=sun4u

The following command creates a group that is named building19 under an existing domain that is named headquarters_test:

> createGroup t=/headquarters_test/building19 \
fullDesc="test headquarters domain" family=building-location

The following command creates a managed entity that is named myHost in the group building12 in the domain test_domain. The topology object is a Sun Ultra-2 host with the agent running in port 1161.

> createEntity t=/test_domain/building12/myHost \
fullDesc="my test host" family=ultra-2 topoType="" \
topoCfg="" isPolled=false pollType=ahost readInfo="" \
writeInfo="" targetHost=osftserv targetIp="" agentPort=1161