PhysicalPortGroup Object

Description:

Object representing a port group residing in a test module.

Writable Attributes
Read-Only Attributes

Parents: PhysicalTestModule

Children: IlCore, Mx100GPortGroupSettings, PhysicalPort, PortGroupSettings

Result children (automatically created): SystemMonitorResults

Relations:

Side name (Type)	Relative	Description
AffiliatedFlexEthernetConfig (AffiliationFlexEthernetPortGroup)	FlexEthernetConfig
ResultChild (ResultChild)	SystemMonitorResults	Use this to connect a results object to an object.

PhysicalPortGroup Writable Attributes

Attribute	Description
Common Writable Attributes	Active, Name

PhysicalPortGroup Read-Only Attributes

Read-Only Attribute

Description

ActiveDataConfigFile

Type: string

Default: Default

CpuCores

CPU cores

Type: u32

Default: 0

Range: 0 - 4294967295

DataConfigUserFiles

Type: string

Default: "" (empty string)

Enabled

Enabled

Type: bool

Default: TRUE

Possible Values:

Value	Description
TRUE	Enabled
FALSE	Disabled

ExpectedTestPackageVersion

Expected test package version.

Type: string

Default: "" (empty string)

FirmwareInstallProgress

Firmware installation progress (in units of percentage complete) for the port group.

Type: u32

Default: 0

FirmwareInstallStatus

Firmware installation status for the port group (for example, "FIRMWARE_INSTALL_IN_PROGRESS").

Type: enum

Default: FIRMWARE_INSTALL_INACTIVE

Possible Values:

Value	Description
FIRMWARE_INSTALL_INACTIVE	Firmware installation is not occurring.
FIRMWARE_INSTALL_IN_PROGRESS	Firmware installation is in progress.
FIRMWARE_INSTALL_REBOOTING	Port group is rebooting during a firmware installation.
FIRMWARE_INSTALL_COMPLETE	Firmware installation is complete.
FIRMWARE_INSTALL_FAILED	Firmware installation failed.

Index

Port group index (value starts at 1).

Type: u16

Default: 1

Range: 1 - 0xFFFF

IsTestPackageVersionValid

Whether the active test package version is compatible with the application.

Type: bool

Default: TRUE

Possible Values:

Value	Description
TRUE	Test package version is valid.
FALSE	test package version is not valid.

OwnerAccessLevel

Access level of the port group owner.

Type: enum

Default: ACCESS_LEVEL_VIEW

Possible Values:

Value	Description
ACCESS_LEVEL_NOAUTH	Owner is currently logged in with NOAUTH access level.
ACCESS_LEVEL_VIEW	Owner is currently logged in with VIEW access level.
ACCESS_LEVEL_SHARED	Owner is currently logged in with SHARED access level.
ACCESS_LEVEL_CONTROL	Owner is currently logged in with CONTROL access level.
ACCESS_LEVEL_ADMIN	Owner is currently logged in with ADMIN access level.
ACCESS_LEVEL_DEBUG	Owner is currently logged in with DEBUG access level.

OwnerHostname

Hostname value used by the current owner when logging into the port group.

Type: string

Default: "" (empty string)

OwnerProcessId

Process ID value used by the current owner when logging into the port group.

Type: string

Default: "" (empty string)

OwnershipState

Ownership status of the port group.

Type: enum

Default: OWNERSHIP_STATE_AVAILABLE

Possible Values:

Value	Description
OWNERSHIP_STATE_AVAILABLE	Port group is available for reservation.
OWNERSHIP_STATE_RESERVED	Port group is currently reserved.
OWNERSHIP_STATE_DISCONNECTED	Current owner has disconnected from the port group but still has it reserved.

OwnerTimestamp

Timestamp value used by the current owner when logging into the port group.

Type: string

Default: "" (empty string)

OwnerUserId

User ID value used by the current owner when logging into the port group.

Type: string

Default: "" (empty string)

PortGroupSiblingCount

Number of port group siblings within the same physical group in the test module.

Type: u16

Default: 1

PortsCsvString

Port group ports csv string

Type: string

Default: 0

PrimaryPortGroupSibling

Type: u16

Default: 0

ReservedByUser

Whether the port group is currently reserved by the application.

Type: bool

Default: FALSE

Possible Values:

Value	Description
TRUE	Port group is reserved by the user.
FALSE	Port group is not reserved by the user.

Size

Port group size

Type: u32

Default: 0

Range: 0 - 4294967295

Status

Current port group status (for example, "MODULE_STATUS_UP").

Type: enum

Default: MODULE_STATUS_UNKNOWN

Possible Values:

Value	Description
MODULE_STATUS_UP	Port group is up.
MODULE_STATUS_DOWN	Port group is down.
MODULE_STATUS_ERROR	Port group is an error state.
MODULE_STATUS_UNKNOWN	Port group status is unknown.

StatusChanged

Last status change for the port group (for example, "MODULE_CHANGE_INIT_DONE").

Type: enum

Default: MODULE_CHANGE_UNKNOWN

Possible Values:

Value	Description
MODULE_CHANGE_INIT_DONE	Port group initialization is complete and it is up.
MODULE_CHANGE_REBOOT	Port group is rebooting.
MODULE_CHANGE_HOTSWAP_IN	Module has been inserted.
MODULE_CHANGE_HOTSWAP_OUT	Module has been removed.
MODULE_CHANGE_SHUTDOWN	Port group is in shutdown state.
MODULE_CHANGE_RESERVATION	Module reservation state has changed.
MODULE_CHANGE_RESTARTING	Restarting Ports
MODULE_CHANGE_POWER_SAVE	Power save
MODULE_CHANGE_POWERING_DOWN	Powering Down
MODULE_CHANGE_WAKING_UP	Waking Up
MODULE_CHANGE_UNKNOWN	Port group status change is unknown.

SyncStatus

Status indicating if a port group is in/out of sync with its time source (for example, "MODULE_IN_SYNC").

Type: enum

Default: MODULE_OUT_OF_SYNC

Possible Values:

Value	Description
MODULE_IN_SYNC	Port group is in sync with its time source.
MODULE_OUT_OF_SYNC	Port group out of sync with its time source.
MODULE_UNKNOWN_SYNC	Port group sync status is unknown.

TestPackage

Current active test package (for example, "stc") running on the port group.

Type: string

Default: "" (empty string)

TestPackageVersion

Version (for example, "2.0.100") for the active test package running on the port group.

Type: string

Default: 0

TestPackageVersionStatus

Description of test package version check.

Type: string

Default: "" (empty string)

TotalMemoryInMb

Total memory (in MB)

Type: u32

Default: 0

Range: 0 - 4294967295

Uptime

Uptime.

Type: string

Default: Unknown