PceReturnCommand Object


Description:

Return Update or Return Command

Can be used with Command Sequencer: Yes

GUI Command Name: PCEP: Return Command

Parents: Project, Sequencer, StcSystem

Children: PcepActiveStatefulCommandConfig

PceReturnCommand Writable Attributes

Attribute Description
Common Writable Attributes ProgressCancelled
ConfigHandle

Pcep Active Stateful Command Config

Type: handle

Default: 0

Flags

Flags

Type: enum

Default: 0

Possible Values:

Value Description
SYNC

Sync

REMOVE

Remove

ADMIN

Administrative

CREATE

Create

P2MP

P2mp

FRAGMENTATION

Fragmentation

ERO_COMPRESSION

Ero Compression

P_FLAG

P Flag

HandleList

PCEP Host/Session Handle List

Type: handle

Default: 0

IsUpdate

Update Flag

Type: bool

Default: TRUE

Possible Values:

Value Description
TRUE

Is UPDATE message

FALSE

Is RETURN message

Operational

Operational

Type: enum

Default: 0

Possible Values:

Value Description
DOWN

Down

UP

Up

ACTIVE

Active

GOINGDOWN

Going Down

GOINGUP

Going Up

RESERVED1

Reserved 1

RESERVED2

Reserved 2

RESERVED3

Reserved 3

PlspId

PLSP-ID

Type: u32

Default: 1

SessionIndex

Session Index

Type: u32

Default: 1

Range: 1 - 1048575

PceReturnCommand Read-Only Attributes

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