| Overview | Package | Class | Deprecated | Help |
| Properties | |
|---|---|
| adminMode |
type=equipment.ChassisMode default=none Displayed(tab/group)=Administrative Mode (/Chassis Mode) |
| aggregateVflState |
aggregateVflState indicates the state of the aggregated
Virtual Fabric Link (VFL).
type=equipment.AggregateVflState access=read-only default=0 Displayed(tab/group)=Virtual Fabric Link State (/Shelf Details) |
| allowImmFamily |
Specifies the IMM card family type for the shelf.
An NE reboot is required for the configured value to take effect.
type=equipment.SasImmFamilyBits default=none Displayed(tab/group)=Allow IMM Family Type (/IMM Family Type) |
| allowImmFamilyType |
Specifies the IMM card family type for the shelf.
An NE reboot is required for the configured value to take effect.
DEPRECATED: 17.3 - Use equipment.Shelf.allowImmFamily instead. type=equipment.SasImmFamilyType default=none |
| aosredundancy.AOSChassisState-Set |
type=Children-Set |
| aosredundancy.VFLink-Set |
type=Children-Set |
| aps.ApsGroup-Set |
type=Children-Set |
| assemblyNo |
DEPRECATED: 11.0.R1 type=string access=read-only default= maximum=252 |
| assignedType |
type=equipment.ShelfType default=1 Displayed(tab/group)=Assigned Type (/Shelf Type) |
| bootEpromVersion |
The version number of boot eprom on the Shelf.
type=string access=read-only default= minimum=0 maximum=255 Displayed(tab/group)=Boot Code Version (Software) |
| bundle.ApsInterface-Set |
type=Children-Set |
| chassisFPGenerationFP2 |
The value of chassisFPGenerationFP2 indicates whether the system contains at least one FP2 based line card.
type=boolean access=read-only Displayed(tab/group)=FP2 (/FP Generations) |
| chassisFPGenerationFP3 |
The value of chassisFPGenerationFP3 indicates whether the system contains at least one FP3 based line card.
type=boolean access=read-only Displayed(tab/group)=FP3 (/FP Generations) |
| chassisFPGenerationFP4 |
The value of chassisFPGenerationFP4 indicates whether the system contains at least one FP4 based line card.
type=boolean access=read-only Displayed(tab/group)=FP4 (/FP Generations) |
| chassisFPGenerationFP5 |
The value of chassisFPGenerationFP5 indicates whether the system contains at least one FP5 based line card.
type=boolean access=read-only Displayed(tab/group)=FP5 (/FP Generations) |
| chassisFPGenerationVFP |
The value of chassisFPGenerationVFP indicates whether the system contains at least one VFP based line card.
type=boolean access=read-only Displayed(tab/group)=VFP (/FP Generations) |
| chassisRebootReqd |
The value of chassisRebootReqd indicates if a condition exists on the node that requires a manually triggered reboot.
type=boolean access=read-only default=false Displayed(tab/group)=System Reboot Required (/Chassis Reboot) |
| chassisRebootReqdReason |
The value of chassisRebootReqdReason identifies the reason(s) why a reboot is required.
type=equipment.RebootRequiredReason access=read-only default=unknown Displayed(tab/group)=Reboot Reason (/Chassis Reboot) |
| chassisSystemProfile |
The value of ChassisSystemProfile indicates the system profile in the Chassis.
type=equipment.ChassisSystemProfileTypes access=read-only default=none Displayed(tab/group)=System Profile (/System Profile) |
| clliCode |
type=string default= minimum=0 maximum=11 Displayed(tab/group)=CLLI Code (/Equipment Codes) |
| codeVersion |
The software product release version number for the software image
currently running on this hardware component.
type=string access=read-only default=unknown minimum=0 maximum=300 Displayed(tab/group)=Software Version (Software) |
| consoleAccess |
The value of ConsoleAccess specifies whether or not debug
console access functionality is enabled on the satellite.
type=boolean default=false Displayed(tab/group)=Console Access (/Shelf Type) |
| coordinates |
The value specifies the Global Positioning
System (GPS) coordinates for the location of the system.
This information will be copied in NetworkElement.coordinates as well.
type=string default= maximum=252 Displayed(tab/group)=Coordinates (/Equipment Codes) |
| defaultImmFamily |
Default Imm Family Type for SAS-R nodes.
type=equipment.SasImmFamilyBits access=read-only default=none Displayed(tab/group)=Default IMM Family Type (/IMM Family Type) |
| defaultImmFamilyType |
Default Imm Family Type for SAS-R nodes.
DEPRECATED: 17.3 - Use equipment.Shelf.defaultImmFamily instead. type=equipment.SasImmFamilyType access=read-only default=none |
| deviceState |
type=equipment.DeviceState access=read-only default=deviceStateUnknown |
| equipment.Airframe-Set |
type=Children-Set |
| equipment.AirframeSysLog-Set |
type=Children-Set |
| equipment.AuxAlarmDefinition-Set |
type=Children-Set |
| equipment.CCM-Set |
type=Children-Set |
| equipment.CardSlot-Set |
type=Children-Set |
| equipment.DigitalAuxAlarm-Set |
type=Children-Set |
| equipment.DryContact-Set |
type=Children-Set |
| equipment.FAM-Set |
type=Children-Set |
| equipment.FanSensor-Set |
type=Children-Set |
| equipment.FanTray-Set |
type=Children-Set |
| equipment.FlashMemory-Set |
type=Children-Set |
| equipment.FlexiblePortMapping-Set |
type=Children-Set |
| equipment.Fru-Set |
type=Children-Set |
| equipment.HDDInventory-Set |
type=Children-Set |
| equipment.HardDiskDrive-Set |
type=Children-Set |
| equipment.HealthMonitoring-Set |
type=Children-Set |
| equipment.HwEnvironment-Set |
type=Children-Set |
| equipment.LEDPanel-Set |
type=Children-Set |
| equipment.PCIEDevInfo-Set |
type=Children-Set |
| equipment.PCMTray-Set |
type=Children-Set |
| equipment.PortAuxAlarmInput-Set |
type=Children-Set |
| equipment.PowerModule-Set |
type=Children-Set |
| equipment.PowerSupply-Set |
type=Children-Set |
| equipment.PowerSupplyTray-Set |
type=Children-Set |
| equipment.PwrConsumption-Set |
type=Children-Set |
| equipment.SFMSlot-Set |
type=Children-Set |
| equipment.SatellitePortMapping-Set |
type=Children-Set |
| equipment.ScadaMddb-Set |
type=Children-Set |
| equipment.Sensor-Set |
type=Children-Set |
| equipment.SwitchFabricProcessor-Set |
type=Children-Set |
| equipment.SystemStatsHolder-Set |
type=Children-Set |
| equipment.TempSensor-Set |
type=Children-Set |
| equipment.VMMapping-Set |
type=Children-Set |
| equipment.VoltageSensor-Set |
type=Children-Set |
| equippedType |
type=equipment.ShelfType access=read-only default=1 Displayed(tab/group)=Equipped Type (/Shelf Type) |
| ethernetequipment.PoEPort-Set |
type=Children-Set |
| expectedAmps |
type=equipment.ExpectedAmpsType default=auto Displayed(tab/group)=Expected PF Amps (/Shelf Details) |
| forceMode |
type=boolean default=false Displayed(tab/group)=Force Mode (/Chassis Mode) |
| geoRedundancyMode |
The geo-redundancy mode of this chassis.
type=equipment.GeoRedundancyMode access=read-only default=activeActive |
| geoStandbyStatus |
The geo-redundancy standby status of this chassis. 'Providing
service' implies this is the local chassis and any other state
implies the chassis is a geo-redundant remote.
type=equipment.StandbyStatus access=read-only default=notRelevant |
| hwRev |
type=string access=read-only default= maximum=252 Displayed(tab/group)=HW Revision (/Manufacturer Details) |
| id |
Relative shelf identifier.
type=int access=read-create default=0 |
| isManaged |
type=boolean default=true Displayed(tab/group)=Is Managed (/Shelf Details) |
| lastBootTime |
The date and time the software running on this Shelf
was last rebooted.
type=string access=read-only default=unknown maximum=252 Displayed(tab/group)=Last Boot Time (Software) |
| lastSystemRebootReason |
type=int access=read-only default=0 Displayed(tab/group)=Last Reboot Reason (/Last System Reboot Details) enums= 0: unknown 1: admin 2: other |
| lastSystemRebootRouter |
type=string access=read-only default= Displayed(tab/group)=Admin Reboot Router (/Last System Reboot Details) |
| lastSystemRebootTime |
type=string access=read-only default=unknown Displayed(tab/group)=Admin Reboot Time (UTC) (/Last System Reboot Details) |
| lastSystemRebootUser |
type=string access=read-only default= Displayed(tab/group)=Admin Reboot User (/Last System Reboot Details) |
| lastSystemRebootUserAddrType |
type=rtr.InetAddressType access=read-only default=unknown |
| lastSystemRebootUserAddress |
type=InetAddress access=read-only default=0.0.0.0 Displayed(tab/group)=Admin Reboot Address (/Last System Reboot Details) |
| licenseConsumed |
The value specifies the number of license points consumed.
type=double access=read-only default=0.0 Displayed(tab/group)=License Points Consumed (/Licensed product and consumed) |
| licensedProduct |
The value specifies the license product.
type=string access=read-only default=None maximum=252 Displayed(tab/group)=Licensed Product (/Licensed product and consumed) |
| location |
The value specifies the site location of the system.
This information will be copied in NetworkElement.location as well.
type=string default= minimum=0 maximum=80 Displayed(tab/group)=Location (/Equipment Codes) |
| lowTemperatureState |
type=equipment.ChassisLowTempState access=read-only default=none Displayed(tab/group)=Low Temperature State (/Shelf Details) |
| maxPowerBudget |
It indicates the maximum power budgeted for PoE ports.
type=float access=read-only units=watts Displayed(tab/group)=Maximum Power Budgeted (PoE/System PoE) |
| mixedMode |
type=boolean default=false Displayed(tab/group)=Mixed Mode State on Chassis Enabled (/Mixed Mode) |
| mpr.Crossconnect-Set |
type=Children-Set |
| mpr.MPRSiteSync-Set |
type=Children-Set |
| mpr.PortSegregation-Set |
type=Children-Set |
| mpr.PwTDMCfgClkSrcPayload-Set |
type=Children-Set |
| multicast.IngrPathMgmtChassisLevelConfigure-Set |
type=Children-Set |
| mwa.MwLink-Set |
type=Children-Set |
| ntp.NTP-Set |
type=Children-Set |
| numberOfCardSlots |
type=int access=read-only default=1 Displayed(tab/group)=Total Slots (/Shelf Details) |
| numberOfInstalledFanTrays |
type=int access=read-only default=0 Displayed(tab/group)=Total Fan Trays (/Shelf Details) |
| numberOfInstalledFans |
type=int access=read-only default=0 Displayed(tab/group)=Total Fans (/Shelf Details) |
| numberOfInstalledPorts |
type=int access=read-only default=0 Displayed(tab/group)=Installed Ports (/Shelf Details) |
| numberOfInstalledPowerSupplies |
type=int access=read-only default=0 Displayed(tab/group)=Total Power Supplies (/Shelf Details) |
| numberOfOperSlots |
type=long access=read-only default=0 Displayed(tab/group)=Operational Slots (/Shelf Details) |
| numberOfmacaddresses |
type=long access=read-only default=0 Displayed(tab/group)=Number of MAC addresses (/Shelf Details) |
| operImmFamily |
Indicates the IMM card family type setting currently in effect for the shelf.
type=equipment.SasImmFamilyBits access=read-only default=none Displayed(tab/group)=Operational IMM Family Type (/IMM Family Type) |
| operImmFamilyType |
Indicates the IMM card family type setting currently in effect for the shelf.
DEPRECATED: 17.3 - Use equipment.Shelf.operImmFamily instead. type=equipment.SasImmFamilyType access=read-only default=none |
| operMode |
type=equipment.ChassisMode access=read-only default=none Displayed(tab/group)=Operational Mode (/Chassis Mode) |
| overTemperatureState |
type=equipment.ChassisTempState access=read-only default=none Displayed(tab/group)=Over Temperature State (/Shelf Details) |
| pfAexpectedAmps |
type=equipment.PFExpectedAmpsType default=amps3dot7 Displayed(tab/group)=PF A Expected (/Shelf Details) |
| pfBexpectedAmps |
type=equipment.PFExpectedAmpsType default=amps8dot5 Displayed(tab/group)=PF B Expected (/Shelf Details) |
| phyShelfRole |
type=equipment.PhysicalChassisRole access=read-only default=unknown Displayed(tab/group)=Chassis Role (/Shelf Details) |
| poeExternalPowerSupplyStatus |
type=equipment.PoeExternalPowerSupplyStatus access=read-only default=absent Displayed(tab/group)=PoE External Power Supply Status (PoE) |
| poeMainPseAvaliablePower |
type=int access=read-only default=60 minimum=0 maximum=60 units=watts Displayed(tab/group)=PSE Power Available (PoE) |
| poeMainPseConsumptionPower |
type=int access=read-only default=0 minimum=0 maximum=60 units=watts Displayed(tab/group)=PSE Power Consumed (PoE) |
| poeMaxPowerBudget |
type=int access=read-only default=60 minimum=0 maximum=60 units=watts Displayed(tab/group)=PSE Maximum Power Budget (PoE) |
| poePowerSupplyMode |
type=equipment.PoePowerSupplyMode default=none Displayed(tab/group)=PoE Power Supply Source (PoE) |
| poePowerSupplyStatus |
type=equipment.PoePowerSupplyStatus access=read-only default=none Displayed(tab/group)=PoE Power Supply Status (PoE) |
| portTemplate |
Specifies the satellite port template which the satellite is using for its physical port scheme.
The value must be specified along with tmnxSatAssignedType. If tmnxSatAssignedType is set without
providing a value for tmnxSatPortTemplate, the satellite will use its factory defined
physical port scheme.
type=string default= Displayed(tab/group)=Template Name (/Shelf Type) |
| portTemplatePointer |
Specifies the port template pointer associated with this Satellite Port Template entry.
type=Pointer default= Displayed(tab/group)=Port Template (/Shelf Type) |
| pseAvaiablePower |
type=int access=read-only default=0 minimum=0 maximum=720 units=watts Displayed(tab/group)=PSE Power Available (PoE/POE General) |
| pseCommittedPower |
type=int access=read-only default=0 minimum=0 maximum=720 units=watts Displayed(tab/group)=PSE Power Committed (PoE/POE General) |
| pseCommittedPowerHPoe |
type=int access=read-only default=0 minimum=0 maximum=360 units=watts Displayed(tab/group)=POE HPOE Committed Power (PoE/POE Committed Power) |
| pseCommittedPowerPlus |
type=int access=read-only default=0 minimum=0 maximum=720 units=watts Displayed(tab/group)=POE Plus Committed Power (PoE/POE Committed Power) |
| pseCommittedPowerPlusPlus |
type=int access=read-only default=0 minimum=0 maximum=240 units=watts Displayed(tab/group)=POE Plus Plus Committed Power (PoE/POE Committed Power) |
| pseCommittedPowerPoe |
type=int access=read-only default=0 minimum=0 maximum=720 units=watts Displayed(tab/group)=POE Committed Power (PoE/POE Committed Power) |
| pseProvisionPowerPoe |
type=int access=read-only default=0 minimum=0 maximum=720 units=watts Displayed(tab/group)=POE Provisioned Power (PoE/POE Provisioned Power) |
| pseProvisionPowerPoeHPoe |
type=int access=read-only default=0 minimum=0 maximum=360 units=watts Displayed(tab/group)=POE HPOE Provisioned Power (PoE/POE Provisioned Power) |
| pseProvisionPowerPoePlus |
type=int access=read-only default=0 minimum=0 maximum=720 units=watts Displayed(tab/group)=POE Plus Provisioned Power (PoE/POE Provisioned Power) |
| pseProvisionPowerPoePlusPlus |
type=int access=read-only default=0 minimum=0 maximum=240 units=watts Displayed(tab/group)=POE Plus Plus Provisioned Power (PoE/POE Provisioned Power) |
| pseProvisionedPower |
type=int access=read-only default=60 minimum=0 maximum=60 units=watts Displayed(tab/group)=PSE Power Provisioned (PoE/POE General) |
| radioequipment.RadioEquipmentInventory-Set |
type=Children-Set |
| runningConfigDir |
type=string access=read-only default=working |
| runningDirectory |
type=sw.AosRunningVersion access=read-only default=certified |
| sasMode |
type=int access=read-only default=mpls_mode Displayed(tab/group)=State (/Uplink Mode) enums= 2: l2uplink_mode - Access Uplink 1: mpls_mode - Network 3: mixed_mode |
| satClientDownDelay |
This property sets the delay between the last
available uplink becoming unavailable and the disabling of the
associated ethernet satellite client ports.
type=int default=-1 minimum=-1 maximum=1800 units=seconds Displayed(tab/group)=Client Down Delay (/Shelf Details) |
| satDynamicUplink |
The value of satDynamicUplink specifies whether the satellite will
be permitted to dynamically re-configure uplink ports in the event of
a failure.
type=boolean default=false Displayed(tab/group)=Dynamic Uplink (/Shelf Type) |
| satFeatureLocalForward |
The value of SatFeatureLocalForward specifies whether the local forward feature is enabled or disabled on the satellite.
type=boolean default=false Displayed(tab/group)=Local Forward (/Feature) |
| satFeaturePtpTc |
The value of SatFeaturePtpTc specifies whether the host should
enforce that the equipped satellite (hardware and software) supports
PTP transparent clock functionality before allowing it to become
operational.
type=boolean default=false Displayed(tab/group)=Ptp Transparent Clock (/Feature) |
| satPtpTc |
The value of SatPtpTc specifies whether or not PTP transparent
clock functionality is enabled on the satellite
type=boolean default=false Displayed(tab/group)=Ptp Transparent Clock (/Shelf Details) |
| satUplinkDistribution |
The value of satUplinkDistribution specifies the maximum resources
the system may allocate for uplink port resiliency. In the
single-complex case, up to two host ports per client port may be
automatically allocated for resiliency. In the dual-complex case, the
system may allocate at-most one host port per client port.
type=int default=none Displayed(tab/group)=Uplink Distribution (/Shelf Type) enums= 0: none - None (not selectable) 1: singleComplex - Single Complex 2: dualComplex - Dual Complex |
| security.AOSLicense-Set |
type=Children-Set |
| serialNum |
type=string default= maximum=18 Displayed(tab/group)=Serial Number (/Shelf Details) |
| shelfAINS |
type=boolean default=false Displayed(tab/group)=AINS Enabled (/Shelf Details) |
| shelfDesc |
type=string default= maximum=255 Displayed(tab/group)=Shelf Description (/Shelf Details) |
| shelfIdCreate |
DEPRECATED: 9.0R3 OBSOLETE, shelfIdCreate Was used in configureShelf command. Please use generic.GenericObject.configureChildInstance to create Shelf on a NE , instead of using configureShelf. shelfIdCreate and configureShelf() will be removed in the later releases of NFM-P. type=int minimum=0 maximum=70 |
| shelfMacAddress |
type=MacAddress default=00-00-00-00-00-00 Displayed(tab/group)=Shelf MacAddress (/Shelf Details) |
| shelfName |
type=string default= maximum=252 Displayed(tab/group)=Name (/Shelf Details) |
| shelfPresentType |
type=equipment.ShelfType access=read-only default=unknownShelf Displayed(tab/group)=Present Shelf Type (/Shelf Details) |
| shelfType |
type=equipment.ShelfType default=unknownShelf Displayed(tab/group)=Shelf Type (/Shelf Details) |
| sonet.SiteSync-Set |
type=Children-Set |
| subNodePointer |
Pointer to gmpls.SubNode instance discovered through the CORBA interface.
Applicable if this is an OCS shelf.
DEPRECATED: 23.4 - No longer applicable to any supported nodes type=Pointer access=read-only default= |
| subSysChassMemoryUsageHigh |
The value of subSysChassMemoryUsageHigh indicates
that the memory usage of the subscriber management function
on this chassis is near the limit
type=generic.TruthValue access=read-only default=false Displayed(tab/group)=Memory Usage High (/Subscriber Management) |
| sw.MPRSoftwareControlModule-Set |
type=Children-Set |
| sw.MPRSoftwarePackage-Set |
type=Children-Set |
| sw.SoftwareControlModule-Set |
type=Children-Set |
| swReposPointer |
type=Pointer default= Displayed(tab/group)=Software Repository (/Shelf Details) |
| switchModel |
type=string access=read-only default= maximum=252 Displayed(tab/group)=Switch Model (/Manufacturer Details) |
| syncE |
The value of SyncE specifies whether or not synchronous
Ethernet is enabled on the satellite.
type=boolean default=false Displayed(tab/group)=Synchronous Ethernet (/Shelf Details) |
| sysPSMaxPoePowerBudget |
This Specifies the maximum power budget for POE enabled nodes.
type=int default=0 minimum=0 maximum=720 units=watts Displayed(tab/group)=POE Maximum Power Budget (PoE) |
| systemPowerAvailable |
It indicates the power available for PoE ports.
type=float access=read-only units=watts Displayed(tab/group)=Power Available (PoE/System PoE) |
| systemPowerCommitted |
It indicates the power committed for PoE ports.
type=float access=read-only units=watts Displayed(tab/group)=Power Committed (PoE/System PoE) |
| systemPowerInUse |
It indicates the power in use by PoE ports.
type=float access=read-only units=watts Displayed(tab/group)=Power in Use (PoE/System PoE) |
| vChassisLocalVCSlot |
vChassisLocalVCSlot indicates the base virtual chassis slot number of the
local chassis with an active CPM.
type=int access=read-only default=0 Displayed(tab/group)=Virtual Chassis Local Slot (/Shelf Details) |
| vwm.AlarmSeverityAssignmentProfile-Set |
type=Children-Set |
| vwm.ExternalAlarmInterface-Set |
type=Children-Set |
| vwm.ExternalAnalogInterface-Set |
type=Children-Set |
| vwm.ExternalControlInterface-Set |
type=Children-Set |
| vwm.PowerInterface-Set |
type=Children-Set |
| vwm.ShelfCraftIP-Set |
type=Children-Set |
| vwm.ShelfISD-Set |
type=Children-Set |
| vwm.ShelfSpecifics-Set |
type=Children-Set |
| Properties inherited from ManagedObject |
|---|
| actionMask, children-Set, deploymentState, isFaultSquelched, name, objectFullName, selfAlarmed |
| Methods |
|---|
deployer
: Deployer - the deployment state
synchronousDeploy
: boolean - (Optional) Specify whether to block until the changes have been fully deployed to the network. A value of "true" means to block. A value of "false" means to return immediately. Default: false (asynchronous)
clearOnDeployFailure
: boolean - (Optional) Specify whether to clear any failed deployers. A value of "true" means to clear. A value of "false" means to leave the failed deployer. Default: false
deployRetries
: int - (Optional) The number of times to attempt re-deployment during synchronous deployment. This parameter is meaningless in the asynchronous case. Default: 0
deployRetryInterval
: long - (Optional) The number of milliseconds to wait between deployment retries. This parameter is meaningless in the asynchronous case. Default: 0
taskDescription
: string - (Optional) A user friendly description of what the operation does. This information will be used by the task manager.
instanceFullName
: string - the full name of the object.
shelfInfo
: generic.CommonManagedEntityConfigurationInformation -
continueOnFailure
: continueOnFailure - (Optional) Continue processing requests in this stream if an exception occurs, unless the request is invalid. Default: false
objectFullName
: Pointer -
equipment.Shelf.configureShelfException
deployer
: Deployer - the deployment state
synchronousDeploy
: boolean - (Optional) Specify whether to block until the changes have been fully deployed to the network. A value of "true" means to block. A value of "false" means to return immediately. Default: false (asynchronous)
clearOnDeployFailure
: boolean - (Optional) Specify whether to clear any failed deployers. A value of "true" means to clear. A value of "false" means to leave the failed deployer. Default: false
deployRetries
: int - (Optional) The number of times to attempt re-deployment during synchronous deployment. This parameter is meaningless in the asynchronous case. Default: 0
deployRetryInterval
: long - (Optional) The number of milliseconds to wait between deployment retries. This parameter is meaningless in the asynchronous case. Default: 0
taskDescription
: string - (Optional) A user friendly description of what the operation does. This information will be used by the task manager.
instanceFullName
: string - the full name of the object.
continueOnFailure
: continueOnFailure - (Optional) Continue processing requests in this stream if an exception occurs, unless the request is invalid. Default: false
equipment.Shelf.deleteShelfException
instanceFullName
: string - the full name of the object.
filter
: FilterHolder -
resultFilter
: ResultFilter - (Optional) Filter for narrowing down the information returned per object
continueOnFailure
: continueOnFailure - (Optional) Continue processing requests in this stream if an exception occurs, unless the request is invalid. Default: false
apsGroupList
: List (summary(aps.ApsGroup)) -
equipment.Shelf.findApsGroupsException
deployer
: Deployer - the deployment state
synchronousDeploy
: boolean - (Optional) Specify whether to block until the changes have been fully deployed to the network. A value of "true" means to block. A value of "false" means to return immediately. Default: false (asynchronous)
clearOnDeployFailure
: boolean - (Optional) Specify whether to clear any failed deployers. A value of "true" means to clear. A value of "false" means to leave the failed deployer. Default: false
deployRetries
: int - (Optional) The number of times to attempt re-deployment during synchronous deployment. This parameter is meaningless in the asynchronous case. Default: 0
deployRetryInterval
: long - (Optional) The number of milliseconds to wait between deployment retries. This parameter is meaningless in the asynchronous case. Default: 0
taskDescription
: string - (Optional) A user friendly description of what the operation does. This information will be used by the task manager.
instanceFullName
: string - the full name of the object.
continueOnFailure
: continueOnFailure - (Optional) Continue processing requests in this stream if an exception occurs, unless the request is invalid. Default: false
equipment.Shelf.rebootException
deployer
: Deployer - the deployment state
synchronousDeploy
: boolean - (Optional) Specify whether to block until the changes have been fully deployed to the network. A value of "true" means to block. A value of "false" means to return immediately. Default: false (asynchronous)
clearOnDeployFailure
: boolean - (Optional) Specify whether to clear any failed deployers. A value of "true" means to clear. A value of "false" means to leave the failed deployer. Default: false
deployRetries
: int - (Optional) The number of times to attempt re-deployment during synchronous deployment. This parameter is meaningless in the asynchronous case. Default: 0
deployRetryInterval
: long - (Optional) The number of milliseconds to wait between deployment retries. This parameter is meaningless in the asynchronous case. Default: 0
taskDescription
: string - (Optional) A user friendly description of what the operation does. This information will be used by the task manager.
instanceFullName
: string - the full name of the object.
continueOnFailure
: continueOnFailure - (Optional) Continue processing requests in this stream if an exception occurs, unless the request is invalid. Default: false
equipment.Shelf.rebootWithFirmwareUpgradeException
deployer
: Deployer - the deployment state
synchronousDeploy
: boolean - (Optional) Specify whether to block until the changes have been fully deployed to the network. A value of "true" means to block. A value of "false" means to return immediately. Default: false (asynchronous)
clearOnDeployFailure
: boolean - (Optional) Specify whether to clear any failed deployers. A value of "true" means to clear. A value of "false" means to leave the failed deployer. Default: false
deployRetries
: int - (Optional) The number of times to attempt re-deployment during synchronous deployment. This parameter is meaningless in the asynchronous case. Default: 0
deployRetryInterval
: long - (Optional) The number of milliseconds to wait between deployment retries. This parameter is meaningless in the asynchronous case. Default: 0
taskDescription
: string - (Optional) A user friendly description of what the operation does. This information will be used by the task manager.
instanceFullName
: string - the full name of the object.
continueOnFailure
: continueOnFailure - (Optional) Continue processing requests in this stream if an exception occurs, unless the request is invalid. Default: false
equipment.Shelf.removeShelfException
deployer
: Deployer - the deployment state
synchronousDeploy
: boolean - (Optional) Specify whether to block until the changes have been fully deployed to the network. A value of "true" means to block. A value of "false" means to return immediately. Default: false (asynchronous)
clearOnDeployFailure
: boolean - (Optional) Specify whether to clear any failed deployers. A value of "true" means to clear. A value of "false" means to leave the failed deployer. Default: false
deployRetries
: int - (Optional) The number of times to attempt re-deployment during synchronous deployment. This parameter is meaningless in the asynchronous case. Default: 0
deployRetryInterval
: long - (Optional) The number of milliseconds to wait between deployment retries. This parameter is meaningless in the asynchronous case. Default: 0
taskDescription
: string - (Optional) A user friendly description of what the operation does. This information will be used by the task manager.
instanceFullName
: string - the full name of the object.
continueOnFailure
: continueOnFailure - (Optional) Continue processing requests in this stream if an exception occurs, unless the request is invalid. Default: false
equipment.Shelf.switchToRedundantECException
deployer
: Deployer - the deployment state
synchronousDeploy
: boolean - (Optional) Specify whether to block until the changes have been fully deployed to the network. A value of "true" means to block. A value of "false" means to return immediately. Default: false (asynchronous)
clearOnDeployFailure
: boolean - (Optional) Specify whether to clear any failed deployers. A value of "true" means to clear. A value of "false" means to leave the failed deployer. Default: false
deployRetries
: int - (Optional) The number of times to attempt re-deployment during synchronous deployment. This parameter is meaningless in the asynchronous case. Default: 0
deployRetryInterval
: long - (Optional) The number of milliseconds to wait between deployment retries. This parameter is meaningless in the asynchronous case. Default: 0
taskDescription
: string - (Optional) A user friendly description of what the operation does. This information will be used by the task manager.
instanceFullName
: string - the full name of the object.
continueOnFailure
: continueOnFailure - (Optional) Continue processing requests in this stream if an exception occurs, unless the request is invalid. Default: false
equipment.Shelf.switchovercmmException
deployer
: Deployer - the deployment state
synchronousDeploy
: boolean - (Optional) Specify whether to block until the changes have been fully deployed to the network. A value of "true" means to block. A value of "false" means to return immediately. Default: false (asynchronous)
clearOnDeployFailure
: boolean - (Optional) Specify whether to clear any failed deployers. A value of "true" means to clear. A value of "false" means to leave the failed deployer. Default: false
deployRetries
: int - (Optional) The number of times to attempt re-deployment during synchronous deployment. This parameter is meaningless in the asynchronous case. Default: 0
deployRetryInterval
: long - (Optional) The number of milliseconds to wait between deployment retries. This parameter is meaningless in the asynchronous case. Default: 0
taskDescription
: string - (Optional) A user friendly description of what the operation does. This information will be used by the task manager.
instanceFullName
: string - the full name of the object.
continueOnFailure
: continueOnFailure - (Optional) Continue processing requests in this stream if an exception occurs, unless the request is invalid. Default: false
equipment.Shelf.vcTakeOverException
| Methods inherited from equipment.Equipment |
|---|
| getDependencyCount |