GetObjectsCommand Object


Description:

Returns a list of objects matching input parameters.

Tcl example:

GetObjects \
    -root $root \
    -class EmulatedDevice \
    -condition {".vlanif -vlanid" ==  "11" AND " -affiliationport-Targets" != "port7" }

Can be used with Command Sequencer: No

Parents: Sequencer

GetObjectsCommand Writable Attributes

Attribute Description
ClassName

Type of object to get.

Type: string

Default: "" (empty string)

Condition

List of conditions that can be ANDed or ORed together. A condition is "L-operand operator literal-value" (for example, address == "1.1.1.1"). The L-operand can be any string that is a valid completion of the partial command, "stc::get instance_of_class". The operator can be == or !=. The literal value can be any string.

Type: string

Default: "" (empty string)

Direction

Direction of the relation for search.

Type: enum

Default: DESTINATION

Possible Values:

Value Description
DESTINATION

Destination.

CHILD

Child.

CHILDREN

Children.

DOWN

Down.

DOWNWARD

Downward.

FORWARD

Forward.

SOURCE

Source.

PARENT

Parent.

UP

Up.

UPWARD

Upward.

BACKWARD

Backward.

BIDIRECTIONAL

Bi-directional.

BOTH

Both.

ALL

All.

RelationType

Type of relation to use for search.

Type: string

Default: ParentChild

RootList

Limits the scope of the search to objects under root. Defaults to system if unspecified.

Type: handle

Default: 0

GetObjectsCommand Read-Only Attributes

Read-Only Attribute Description
ObjectList

Output object list.

Type: handle

Default: 0