ReservePortCommand Object


Description:

Reserve one or more ports.

Can be used with Command Sequencer: No

Parents: Sequencer, StcSystem

ReservePortCommand Writable Attributes

Attribute Description
Common Writable Attributes ProgressCancelled
AbortOnError

Whether to Abort On Error.

Type: bool

Default: TRUE

Possible Values:

Value Description
TRUE

Abort.

FALSE

Do not abort.

Location

List of chassis/slot/port values (example: "10.100.10.1/1/1") for the ports to reserve.

Type: csp

Default: //(Offline)/1/1

PortList

List of handles of the ports to reserve.

Type: handle

Default: 0

RevokeOwner

Whether to kick off the current owners of the ports and reserve the ports.

Type: bool

Default: FALSE

Possible Values:

Value Description
TRUE

Kick off current owners.

FALSE

Reserve only if the ports are available.

ReservePortCommand Read-Only Attributes

Read-Only Attribute Description
Common Read-Only Attributes ElapsedTime, EndTime, ProgressCurrentStep, ProgressCurrentStepName, ProgressCurrentValue, ProgressDisplayCounter, ProgressMaxValue, ProgressStepsCount, StartTime, State, Status