Class policy:Object (ABSTRACT)

Class ID:524
Encrypted: false - Exportable: false - Persistent: true
Privileges: []
SNMP OID:

NO COMMENTS


Naming Rules


DN FORMAT: 

                




Inheritance
naming:NamedObject
 ├
policy:Object
 
 ├
flowctrl:Item A Flow Control Policy
 
 ├
hostimg:Target Target
 
 ├
imgprov:Target Target
 
 ├
policy:Binding
 
 
 ├
equipment:ChassisProfileBinding Abstract Representation of a binding between a Chassis profile and chassis //TODO -> define access properly
 
 
 
 ├
equipment:Binding Represents a Binding between a Chassis Profile and a specified Chassis The API user explicitly bind a Chassis Profile to a Chassis
 
 
 
 ├
equipment:Requirement Represents a Binding between a ChassisProfile and a pool of Chassis The Requirements refers to a pool of chassis and a chassis qualification
 
 
 ├
ls:ComputeBinding Abstract Representation of a binding between a ls:Server and physical server.
 
 
 
 ├
ls:Binding Represents a Binding between a ls:Server and a specified physical server. The API user explicitly bind a ls:Server to a physical server, which could be a blade in a specific slot, or a rack server.
 
 
 
 ├
ls:Requirement Represents a Binding between a ls:Server and a pool of physical servers. The Requirements refers to a pool of physical servers and a server qualification, which can specify additional constraints such as the minimum amount of RAM available on the physical server.
 
 
 ├
lstorage:ProfileBindingBase An abstract representation of a binding object between a {@link ls:Server} and a {@link lstorage:Profile}.
 
 
 
 ├
lstorage:ProfileBinding Represents a binding between a Service Profile ({@link ls:Server}) and a {@link lstorage:Profile}
 
 ├
policy:Definition
 
 
 ├
aaa:Definition
 
 
 
 ├
aaa:Banner
 
 
 
 
 ├
aaa:PreLoginBanner
 
 
 
 ├
aaa:Ep AAA End points that a user can configure (Radius, Tacacs+, LDAP)
 
 
 
 
 ├
aaa:LdapEp
 
 
 
 
 ├
aaa:RadiusEp
 
 
 
 
 ├
aaa:TacacsPlusEp
 
 
 
 ├
aaa:ExtMgmtCutThruTkn
 
 
 
 ├
aaa:Locale This MO represents a Locale, which can be used to restrict access to specific orgs in the org hierarchy. A Locale can be assigned to local user, remote user, ldap groups to restrict access to specific orgs. Each locale can contain a set of aaa:Org objects, which represent the set of Orgs that can be accessed when the Locale is assigned to a user.
 
 
 
 ├
aaa:PwdProfile This MO stores informaion about password constratints applicable to all the local users.
 
 
 
 ├
aaa:Realm AAA configuration to set which AAA service to use
 
 
 
 
 ├
aaa:AuthRealm Future Use
 
 
 
 ├
aaa:Role This MO is used to manage a role which can be assigned to local user, remote user, ldap groups to control access for an user.
 
 
 
 ├
aaa:UserData Do not taking backup of this MO, this user data become invalid with time
 
 
 
 ├
aaa:UserEp
 
 
 
 ├
aaa:UserLogin Represents a successful User Login session
 
 
 
 
 ├
aaa:EpLogin
 
 
 
 
 ├
aaa:ShellLogin Represents a successful User Login session from a shell
 
 
 
 
 ├
aaa:WebLogin Represents a successful User Login session through HTTP or HTTPS
 
 
 ├
aaa:EpAuthProfile An IPMI authentication profile
 
 
 ├
adaptor:HostIfProfile
 
 
 
 ├
adaptor:HostEthIfProfile
 
 
 
 ├
adaptor:HostFcIfProfile
 
 
 
 ├
adaptor:HostIscsiIfProfile
 
 
 ├
bios:VProfile
 
 
 ├
callhome:Ep
 
 
 ├
capability:Def
 
 
 
 ├
compute:ConstraintDef equipment constraints on blades
 
 
 
 ├
compute:MemoryUnitConstraintDef DIMM constraints on blades.
 
 
 
 ├
compute:PciSlotScanDef
 
 
 
 ├
equipment:AdaptorConnDef Adaptor ort Conn defines the end points (ports) on the adaptor and IOM sides.
 
 
 
 ├
equipment:AdaptorDef I/O adaptor properties such as maximum speeds.
 
 
 
 ├
equipment:AdvancedBootOrder
 
 
 
 ├
equipment:BeaconCapProvider
 
 
 
 ├
equipment:BiosDef Added for bios update for romley platforms
 
 
 
 ├
equipment:BiosTokenOverride Added to check if Option ROM is enabled
 
 
 
 ├
equipment:BladeAGLibrary
 
 
 
 ├
equipment:BladeConnDef Blade Connectivity defines the connectivity between the adaptor and the IOM/FEX.
 
 
 
 ├
equipment:BladeIOMConnDef
 
 
 
 ├
equipment:BladeSwitchConnDef
 
 
 
 ├
equipment:BoardControllerDef
 
 
 
 ├
equipment:BootDeviceConstraints
 
 
 
 ├
equipment:BreakoutCap
 
 
 
 ├
equipment:CimcVmedia
 
 
 
 ├
equipment:CiscoOsOpenGate
 
 
 
 ├
equipment:DiagFeatureSupport Added for E2E feature in delnorte
 
 
 
 ├
equipment:DimmMapping Holder for smbios dimm mapping DIMM's are identified in UCSM by a unique id. A mapping is needed between the locator in the SMBIOS table and the UCSM.
 
 
 
 ├
equipment:EmbeddedControllerConfig The embedded controller (PCH) on the server board can operate in SW-RAID and AHCI modes. This configuration is deployed through BIOS tokens. When the user selects the controller mode through ControllerDef, UCSM sets the bios-tokens to change the mode of the controller. This MO captures the token and its configurations to be applied by UCSM for the server
 
 
 
 ├
equipment:EmbeddedStorageDef catalog for storing disk properties of NVMe SSDs - required for supporting hot plug and HHHL form factor
 
 
 
 ├
equipment:FanModuleDef fan module capabilities
 
 
 
 ├
equipment:FanPresenceDef
 
 
 
 ├
equipment:FlashLife
 
 
 
 ├
equipment:FlexFlashNonRemovable
 
 
 
 ├
equipment:GemPortCap
 
 
 
 ├
equipment:HDDFaultMonDef
 
 
 
 ├
equipment:IOCardTypeDef IOCard Type Def
 
 
 
 ├
equipment:LocalDiskControllerDef
 
 
 
 ├
equipment:LocalDiskDef local disk unit properties
 
 
 
 ├
equipment:ManufacturingDef Manufacturing-related properties such as PID and SKU.
 
 
 
 ├
equipment:MemoryUnitDiscoveryModifierDef Rules for modifying DIMM discovery
 
 
 
 ├
equipment:NonCopperPassiveCap
 
 
 
 ├
equipment:NvmeDef Capability catalogue to specify the slot ID from which NVMe HHHL can start(Total number of NVMe disk slots plus 1). This is required to prevent conflict of ID between NVMe SFF and NVMe HHHL
 
 
 
 ├
equipment:NvmeSwitchConfig
 
 
 
 ├
equipment:OnboardDeviceDef
 
 
 
 ├
equipment:PciDef
 
 
 
 ├
equipment:PciSlotIdMapping Holder for pci slot name to id mapping
 
 
 
 ├
equipment:PfcMmuCap
 
 
 
 ├
equipment:PhysicalDef Physical properties such as maximum temperature and removal conditions.
 
 
 
 ├
equipment:PnuosBootMode
 
 
 
 ├
equipment:PortCap This defines capability of an aggregate-port. Aggregate Port can be divided into a number of Break-Out ports using a break-out cable.
 
 
 
 ├
equipment:PortGroupAggregationDef FEX/IOCARD portgroup aggregation properties
 
 
 
 ├
equipment:PortGroupDef FEX/IOCARD portgroup properties
 
 
 
 ├
equipment:PortGroupSwComplexDef FABRIC-INTERCONNECT PORT SWITCHING COMPLEX (ASIC) MAPPING DEFINITION
 
 
 
 ├
equipment:PortSwComplexRef
 
 
 
 ├
equipment:ProcessorUnitDef processor unit properties such as maximum clock rate.
 
 
 
 ├
equipment:PsuDef Psu capabilities
 
 
 
 ├
equipment:RackFanModuleDef Fan instances per fan module
 
 
 
 ├
equipment:RaidDef
 
 
 
 ├
equipment:SecureBoot
 
 
 
 ├
equipment:ServerPortCapProvider
 
 
 
 ├
equipment:ServiceDef Service properties such as removal conditions and slot array descriptor name.
 
 
 
 ├
equipment:SlotArray A Slot Array has sufficient properties to render a reasonable sketch of the chassis.
 
 
 
 ├
equipment:SlotArrayRef Reference from a FRU to a Slot Array. Also defines the slot span of the FRU.
 
 
 
 ├
equipment:StorageControllerConfig
 
 
 
 ├
equipment:StorageNvmeSwitchDef
 
 
 
 ├
equipment:StorageSasExpanderDef
 
 
 
 ├
equipment:SwitchCap Represents a Switch entry in the catalogue
 
 
 
 ├
equipment:SwitchTypeDef
 
 
 
 ├
equipment:UnifiedPortCapProvider
 
 
 ├
cimcvmedia:MountConfig This is the base MO for MountConfigPolicy & MountConfigDef
 
 
 
 ├
cimcvmedia:MountConfigDef This is the DefMo maintained under computePhysicalMo and also the same MO is used for specific vMedia policy (unnamed) where it is maintained under lsServerMo
 
 
 
 ├
cimcvmedia:MountConfigPolicy This mo represents the named Scriptable VMedia Policy
 
 
 ├
clitest:TypeTestParent
 
 
 
 ├
clitest:TypeTestChild
 
 
 ├
comm:Definition
 
 
 
 ├
comm:Client CLIENT END-POINTS
 
 
 
 
 ├
sysfile:Exporter
 
 
 
 
 
 ├
mgmt:Backup
 
 
 
 
 
 ├
sysdebug:Exporter
 
 
 
 
 
 
 ├
sysdebug:CoreFileExportTarget
 
 
 
 
 
 
 
 ├
sysdebug:AutoCoreFileExportTarget
 
 
 
 
 
 
 
 ├
sysdebug:ManualCoreFileExportTarget
 
 
 
 
 
 
 ├
sysdebug:LogExportPolicy
 
 
 
 
 ├
sysfile:Importer
 
 
 
 
 
 ├
mgmt:Importer
 
 
 
 ├
comm:Svc default port value is 0. All services that have assigned port override port value. 0 indicates that this service does not use a separate port
 
 
 
 
 ├
comm:DateTime Object to hold system date/time information
 
 
 
 
 ├
comm:Dns Specifies the DNS domain name of this UCS system.
 
 
 
 
 ├
comm:Shell
 
 
 
 
 
 ├
comm:SmashCLP
 
 
 
 
 
 ├
comm:Ssh Ssh MO is not user modifiable, so no access is defined However, it must be present in the model for iptables to allow the port
 
 
 
 
 
 ├
comm:Telnet
 
 
 
 
 ├
comm:Snmp
 
 
 
 
 ├
comm:Syslog
 
 
 
 
 ├
comm:Web
 
 
 
 
 
 ├
comm:CimcWebService
 
 
 
 
 
 ├
comm:Cimxml
 
 
 
 
 
 ├
comm:Http
 
 
 
 
 
 ├
comm:Https
 
 
 
 
 
 ├
comm:Wsman
 
 
 
 
 
 ├
comm:XmlClConnPolicy
 
 
 
 ├
comm:SvcChannel to define whether channel is plain text, unencrypted SSL or full SSL
 
 
 
 
 ├
comm:EvtChannel
 
 
 
 
 ├
comm:WebChannel
 
 
 
 ├
comm:SvcEp Service configuration for various services
 
 
 
 ├
comm:SvcLimits Session Limits for shell and web logins presently max of 32 shell logins are allowed ShellSvcLimits is overriding these properties to set accordingly
 
 
 
 
 ├
comm:ShellSvcLimits
 
 
 
 
 ├
comm:WebSvcLimits
 
 
 ├
comm:SvcPolicy
 
 
 ├
compute:Container
 
 
 
 ├
compute:Item Abstraction of compute item. Serves as a superclass of physical compute nodes (s.a. blade, stand-alone computrer or server) and logical partitions (LPAR, VPAR etc.)
 
 
 
 
 ├
compute:Physical Physical specification of abstract compute item. Serves as a superclass of physical compute nodes (s.a. blade, stand-alone computrer or server)
 
 
 
 
 
 ├
compute:Blade A physical compute blade. Physical compute item in blade form factor.
 
 
 
 
 
 ├
compute:RackUnit A physical compute RackUnit. Physical compute item representing a Rack mountable unit.
 
 
 
 
 
 ├
compute:ServerUnit A server instance on a cartridge.
 
 
 
 ├
compute:Logical Logical specification Abstraction of compute item. Serves as a superclass of logical compute items s.a partitions (LPAR, VPAR etc.)
 
 
 
 
 ├
compute:Server
 
 
 
 
 
 ├
ls:Server Logical Server Definition. Holds and Regulates Specification of: identity connectivity applied to the physical compute node like compute:Blade upon association. Logical Server can serve the following purposes: associatable instance initialization template persistent ...
 
 
 
 
 ├
compute:VirtualContainer
 
 
 
 
 
 ├
compute:Partition Logical partition of physical compute. (e.g. LPAR, VPAR)
 
 
 
 
 
 ├
compute:Virtual Virtual compute. (e.g. LPAR, VPAR)
 
 
 
 
 
 
 ├
vm:ClientContainer Compute resource centric abstraction of a compute container which requests vnics. TODO: The dvsName and dvsDn need to be removed.
 
 
 
 
 
 
 
 ├
vm:ComputeEp Represents a compute endpoint (e.g. userland process)
 
 
 
 
 
 
 
 ├
vm:Virtual Superclass for vm:Hv & vm:Instance.
 
 
 
 
 
 
 
 
 ├
vm:Hv Abstraction of a HyperVisor instance
 
 
 
 
 
 
 
 
 ├
vm:Instance Abstraction of a vitual machine instance.
 
 
 
 ├
equipment:ChassisProfile Chassis Profile Definition. Holds and Regulates Specification of: identity connectivity applied to the chassis upon association. Chassis profile can serve the following purposes: associatable instance initialization template persistent binding template ...
 
 
 ├
compute:GraphicsCardPolicy
 
 
 ├
compute:KvmMgmtPolicy
 
 
 ├
compute:MemoryConfigPolicy Policy Mo for memory related settings.
 
 
 ├
compute:PowerSyncDef
 
 
 ├
compute:PowerSyncPolicy
 
 
 ├
compute:PsuDef ChassisConnPolicy definition moved to commonModel mo name="LinkRetentionPolicy" super="policy:Definition" concrete="yes" deletability="never" access="admin,pn-policy" backup="yes" label="Link Retention Policy" >
 
 
 
 ├
compute:PsuControl
 
 
 
 ├
compute:PsuPolicy
 
 
 ├
compute:QualBase
 
 
 
 ├
compute:Qual Qualification of compute resource. - CPU - memory - storage - adaptor
 
 
 ├
compute:QualifiedPolicy
 
 
 
 ├
compute:ConfigPolicy
 
 
 
 
 ├
compute:DiscPolicy
 
 
 
 
 
 ├
compute:AChassisDiscPolicy An abstract representation of a chassis discovery policy
 
 
 
 
 
 
 ├
compute:ChassisDiscPolicy The chassis discovery policy
 
 
 
 
 
 ├
compute:ChassisConnPolicy
 
 
 
 
 
 ├
compute:ComputeDiscPolicy
 
 
 
 
 
 
 ├
compute:BladeDiscPolicy
 
 
 
 
 
 
 ├
compute:ServerDiscPolicy
 
 
 
 
 
 ├
compute:HwChangeDiscPolicy
 
 
 
 
 
 ├
compute:PortDiscPolicy The port discovery policy
 
 
 
 
 
 ├
compute:RackConnLinkPolicy
 
 
 
 
 
 ├
compute:ServerMgmtPolicy This policy determines if a Rack Server's Mgmt should be a) auto-acked - in which case the first Mgmt connectivity detected shall be acknowledged by the system. b) user-acked - in which case the user will have to ack the required mgmt connectivity
 
 
 
 
 ├
compute:InitConfigPolicy The base class for all auto-configuration and server inheritance policies.
 
 
 
 
 
 ├
compute:AutoconfigPolicy
 
 
 
 
 
 ├
compute:BladeInheritPolicy
 
 
 
 ├
compute:PoolingPolicy
 
 
 
 ├
power:AGroup
 
 
 
 
 ├
power:Group Group represents the power group.
 
 
 ├
compute:ScrubPolicy
 
 
 ├
condition:Policy
 
 
 
 ├
event:Policy The event policy, which specifies how many events to keep in the event log and the event retention policy.
 
 
 
 ├
fault:BasePolicy Specifies the base fault policy, including fault retention, flapping and clear action parameters.
 
 
 
 
 ├
fault:Policy Specifies the fault policy, including fault retention, flapping and clear action parameters.
 
 
 ├
cpmaint:MaintPolicy Chassis Profile Maintenance Policy Class
 
 
 ├
diag:RunPolicy
 
 
 ├
dpsec:Mac
 
 
 ├
equipment:ComputeConnPolicy
 
 
 ├
equipment:QualBase
 
 
 
 ├
equipment:Qual
 
 
 ├
equipment:QualifiedPolicy
 
 
 
 ├
equipment:ConfigPolicy
 
 
 
 
 ├
equipment:InitConfigPolicy The base class for all auto-configuration and inheritance policies.
 
 
 
 
 
 ├
equipment:AutoconfigPolicy
 
 
 
 
 
 ├
equipment:ChassisInheritPolicy
 
 
 
 ├
equipment:PoolingPolicy
 
 
 ├
equipment:Tier Tier
 
 
 ├
extmgmt:IfMonPolicy
 
 
 ├
extvmm:FNDReference FNDReference objects are used by uplink port-profiles to determine which fabric network definitions or network sites are avaliable to the DVS. This object maintains a reference to an FND object
 
 
 ├
extvmm:FabricNetwork NON SINGLETON NETWORK OBJECTS Fabric Network or Logical Network, contains multiple FNDs or Network Sites
 
 
 ├
extvmm:FabricNetworkDefinition Fabric Network Definition or Network Site, contains multiple VMNDs or Network Segments
 
 
 ├
extvmm:Provider REPRESENTS A SINGLE EXTERNAL VM-MANAGEMENT ENTITY
 
 
 ├
extvmm:SwitchDelTask This MO is used to track the deletion task of a given extvmm:Provider MO. When a user deletes a vm:Switch (or any of its parent MOs), the system implicitly creates a extvmm:SwitchDelTask instance. After deletion of the vm:Switch, the user may realize the IP address of vCenter has changed. The user can use the properties of this MO to complete the deletion of the vm:Switch.
 
 
 ├
extvmm:UpLinkPP UplinkPP objects contains references to FNDs. This object is used to link the DVS to the different network sites.
 
 
 ├
extvmm:VMNDRef VMNDRef objects contain a reference to a VM network definition. These are used by VM Networks to determine which VMNDs or Network Segements are available to the VM Network.
 
 
 ├
extvmm:VMNetwork VM Networks provide VM VNICs access to Network Segments (VMNDs) through VMND References.
 
 
 ├
extvmm:VMNetworkDefinition VM Network Definition or Network Segment each contain a single VLAN reference. The VLAN can be a regular VLAN or pVlan. If pVlan is used, every VMND under a single FND must have the same primary VLAN. A mix of regular VLANs and pVlans underneath a single FND is permitted. VMND also maintains a reference to an externally-managed IP Pool. This IP Pool is used by an...
 
 
 ├
fabric:EthLinkProfile Reference to UDLD Link policy. Expect it to be set to a specific name or default else ref policy fault will be raised
 
 
 ├
fabric:FcZoneProfile A ZoneProfile contains multiple user defined zones
 
 
 ├
fabric:FlowMonDefinition
 
 
 ├
fabric:FlowMonExporter
 
 
 
 ├
fabric:LanFlowMonExporter
 
 
 
 
 ├
fabric:EthLanFlowMonExporter
 
 
 
 
 
 ├
fabric:NetflowMonExporter
 
 
 ├
fabric:FlowMonExporterProfile A representation of a communication profile that can be used by one or more netflow exporters for communicating with one or more external netflow collectors. This mo contains all the network policies and properties that can be used by netflow exporters to configure the network infrastructure required for communicating with the external collector.
 
 
 ├
fabric:FlowMonitor
 
 
 
 ├
fabric:LanFlowMonitor
 
 
 
 
 ├
fabric:EthLanFlowMonitor
 
 
 
 
 
 ├
fabric:NetflowMonitor
 
 
 ├
fabric:LacpPolicy
 
 
 ├
fabric:LanCloudPolicy
 
 
 ├
fabric:LinkPolicy Abstract class for link policies
 
 
 
 ├
fabric:EthLinkPolicy Abstract class for ethernet link protocols
 
 
 
 
 ├
fabric:EthCdpPolicy Abstract class for ethernet CDP policies
 
 
 
 
 
 ├
fabric:CdpLinkPolicy CDP policy used to configure on per uplink port
 
 
 
 
 ├
fabric:EthUdldPolicy Abstract class for Cisco UDLD policy
 
 
 
 
 
 ├
fabric:UdldLinkPolicy Unidirectional link detection policy used to configure on per uplink port.
 
 
 ├
fabric:MulticastPolicyPolicy to define configurations for multicast traffic. Currently it is used for IGMP multicast traffic to control snooping & querier configurations on a VLAN.
 
 
 ├
fabric:NetflowTimeoutPolicy
 
 
 ├
fabric:PinGroup An abstract representation of a PIN group. This serves as a base class for Ethernet PIN groups and FC PIN Groups.
 
 
 
 ├
fabric:LanPinGroup An Ethernet PIN Group, which specifies how to distribute the traffic from the servers on the Ethernet uplink interfaces. UCS uses LAN pin groups to pin Ethernet traffic from a vNIC on a server to an uplink Ethernet port or port channel on the fabric interconnect. You can use this pinning to manage the distribution of traffic from the servers. To configure pinning for a server, you must include the LAN pin group in a vNIC poli...
 
 
 
 ├
fabric:SanPinGroup A Fibre Channel (FB) PIN Group, which specifies how to distribute the traffic from the servers on the Fibre Channel uplink interfaces. UCS uses SAN pin groups to pin FB traffic from a vHBA on a server to an uplink FB port or port channel on the fabric interconnect. You can use this pinning to manage the distribution of traffic from the servers. To configure pinning for a server, you must include the SAN pin group in a vHBA po...
 
 
 ├
fabric:UdldPolicy Policy for UDLD global configurations, i.e. applies to all UDLD capable ports
 
 
 ├
fabric:VConProfile A vNIC/vHBA placement policy. vNIC/vHBA placement policies are used to determine what types of vNICs or vHBAs can be assigned to the physical adapters on a server. Each vNIC/vHBA placement policy contains four virtual network interface connections (vCons) that are virtual representations of the physical adapters. When a vNIC/vHBA placement policy is assigned to a service profile, and the service p...
 
 
 ├
fault:SuppressPolicy
 
 
 ├
firmware:AutoSyncPolicy The firmware synchronization policy to update recently discovered blade servers or rack-mount servers.
 
 
 ├
firmware:CompItem TODO: Used for Compatibility checking
 
 
 
 ├
firmware:CompSource
 
 
 
 ├
firmware:CompTarget
 
 
 ├
firmware:Distributable Represents a distributable (downloadable) bundle. UCS includes the infrastructure bundle, the "blade" bundle and the "rack-server" bundle. A bundle contains {@link firmware:DistImage} images.
 
 
 ├
firmware:Image Represents a physical image file in bootflash. Created implicitely as part of download operation.
 
 
 ├
firmware:Pack An abstraction of set of firmware images that are deployed together against specific set of end-points. Pack can contain none, some or all applicable images.
 
 
 
 ├
firmware:CatalogPack A specification of Catalog Pack, providing the catalog to be used/applied for the system
 
 
 
 ├
firmware:ChassisPack Chassis pack
 
 
 
 ├
firmware:ComputePack A specification of Deployable Pack, providing abstraction of set of firmware images that are deployed together against a compute resource.
 
 
 
 
 ├
firmware:ComputeHostPack A specification of (Deployable) Compute Pack, providing representation of set of firmware images that are deployed together against a host visible resources (end-points) s.a. disk controllers, nics, hbas etc.
 
 
 
 
 ├
firmware:ComputeMgmtPack A specification of (Deployable) Compute Pack, providing representation of set of firmware images that are deployed together against a compute management end-points s.a. bmc.
 
 
 
 ├
firmware:InfraPack A specification of (Deployable) Pack, providing representation of set of firmware images that are deployed together against infrastructure resources (end-points) s.a. UCSM, FIs, iom etc.
 
 
 ├
flowctrl:Definition
 
 
 ├
hostimg:Policy
 
 
 ├
imgprov:Policy TODO: IMPLEMENT/DEFINE ME
 
 
 ├
imgsec:Policy
 
 
 ├
iscsi:AuthProfile
 
 
 ├
license:Feature A system-wide representation of a licensable feature exists to specify system-wide properties of that feature. It is identified by the {name, vendor, version} triplet.
 
 
 ├
ls:AgentPolicy blah blah AgentPolicy Class
 
 
 ├
ls:Tier Tier
 
 
 ├
lsboot:ADef the main container for all boot order categories in an LS
 
 
 
 ├
lsboot:Def TODO: decide the role if it admin or read-only Def
 
 
 
 ├
lsboot:Policy
 
 
 ├
lsmaint:MaintPolicy Maintenance Policy Class
 
 
 ├
lstorage:DiskGroupConfig
 
 
 
 ├
lstorage:DiskGroupConfigDef
 
 
 
 ├
lstorage:DiskGroupConfigPolicy
 
 
 ├
lstorage:DiskZoningConfig
 
 
 
 ├
lstorage:DiskZoningConfigDef
 
 
 
 ├
lstorage:DiskZoningPolicy
 
 
 ├
lstorage:ProfileBase An abstract base class for specifying {@link ls:Server} storage requirements. When both {@link lstorage:ProfileDef} and {@link lstorage:Profile} are specified for a given {@link ls:Server}, the storage profile definition is always checked first, and then, if not found, hierarchical resolution of the storage profile policy by name is performed.
 
 
 
 ├
lstorage:Profile An object in the org hierarchy that encapsulates storage requirements for a service profile. A storage profile specifies all the storage requirements (Local and remote LUNs, NFS, CIFS...) of a service profile. When the storage profile is deployed, the system automatically selects one or more storage sub-systems and configures the storage as specified in the storage profile. ...
 
 
 
 ├
lstorage:ProfileDef An object contained by {@link ls:Server} that encapsulates the service profile storage requirements. This object provides the same functionality as a {@link lstorage:Profile}, but unlike a {@link lstorage:Profile}, it is contained directly under a {@ls:Server}. This can be useful in cases when the {@link ls:Server} must be self-contained. The storage specified under a Stor...
 
 
 ├
lstorage:SasExpanderConfigPolicy
 
 
 ├
mgmt:AccessPolicyItem
 
 
 ├
mgmt:BackupExportExtPolicy
 
 
 ├
mgmt:ExportPolicy Configuration export policy
 
 
 
 ├
mgmt:BackupPolicy
 
 
 
 ├
mgmt:CfgExportPolicy
 
 
 ├
mgmt:KmipCertPolicy This policy is used to provide configuration to creates certificates on the BMC for use by KMIP client library.
 
 
 ├
mgmt:KvmCertificate
 
 
 ├
nfs:MountDef MountDef is the NFS policy.
 
 
 ├
nwctrl:Definition
 
 
 ├
pki:Definition
 
 
 
 ├
pki:Ep PKI config: keyrings and CA certs
 
 
 
 ├
pki:Item
 
 
 
 
 ├
pki:KeyRing
 
 
 
 
 ├
pki:TP CA object, also called Trust Points in DCOS
 
 
 ├
pool:Pool Abstraction of shared resource pool. A generic abstraction of resource pool. Pool contains PoolMembership objects that terminate on corresponding Poolable entities. If such PoolMember relationship exists a corresponding Poolable object is said to be a member of given pool.
 
 
 
 ├
compute:Pool Represents a pool of compute items s.a. physical item like blade or a logical item like partition. When given compute item is a member of a given pool a Poolable object is instantiated under such item to indicate that this item belong to this pool. In addition a Pooled object representing membership of given item in this pool is created un...
 
 
 
 ├
equipment:Pool Represents a chassis pool
 
 
 
 ├
fabric:BaseNetGroup
 
 
 
 
 ├
fabric:ANetGroup
 
 
 
 
 ├
fabric:ASanGroup
 
 
 
 
 
 ├
fabric:SanGroup
 
 
 
 ├
fabric:NetGroup A group of VLANs. A fabric:NetGroup contains zero or more pool members, each member refers to a named fabric:Vlan. One of the member may be tagged as the native VLAN, using the fabric:PooledVlan:isNative property. At most one member VLAN can be tagged as the native VLAN. A fabric:NetGroup can be assigned to logical entities, such as service profile vNICs, Et...
 
 
 
 ├
fcpool:Initiators Pool of shared WWN addresses used for logical resource identity assignments. An FC pool can contain a set of WWN ranges (fcpool:Block) and/or specific WWN addresses (fcpool:Initiator), and can be used for FC port WWNs and FC node WWNs.
 
 
 
 ├
ippool:Pool Pool of shared IP addresses used for logical resource identity assignments.
 
 
 
 ├
iqnpool:Pool Pool of shared IQN names used for logical resource identity assignments.
 
 
 
 ├
macpool:Pool Pool of shared MAC addresses used for logical resource identity assignments.
 
 
 
 ├
uuidpool:Pool Pool of shared UUID addresses used for logical resource identity assignments.
 
 
 ├
power:GroupAdditionPolicy Global policy for throttling power on chassis addition
 
 
 ├
power:MgmtPolicy Give the choice to user. Enforce per-blade cap OR policy driven cap
 
 
 ├
power:Placement Placement Policy specifies physical location of SP
 
 
 ├
power:Policy ^M ^M ^M ^M
 
 
 ├
qos:Definition
 
 
 
 ├
epqos:Definition
 
 
 
 ├
epqos:DefinitionDelTask
 
 
 
 ├
qosclass:Definition
 
 
 ├
rule:Definition
 
 
 
 ├
networkrule:Definition
 
 
 ├
sol:Def Abstraction of Serial over LAN configuration definition. Specifies configuration of Serial over LAN interface on a given compute resource. Serial over LAN can be specified per Org as a policy, in which case it is referenced by logical server profile definition by name and is applied to the corresponding blade per association in form of specific SoL interface. ...
 
 
 
 ├
sol:Config Abstraction of Serial over LAN configuration definition. Specifies configuration of Serial over LAN interface on a given compute resource. SOL configuration is optionally instantiated under logical server profile.
 
 
 
 ├
sol:If Abstraction of Serial over LAN configuration definition. Specifies configuration of Serial over LAN interface on a given compute resource. Serial over LAN Interface is implicitly derived from corresponding configuration of the logical server.
 
 
 
 ├
sol:Policy Abstraction of Serial over LAN configuration definition. Specifies configuration of Serial over LAN interface on a given compute resource. Serial over LAN can be specified per Org as a policy, in which case it is referenced by logical server profile definition by name and is applied to the corresponding blade per association in form of specific SoL interface. ...
 
 
 ├
stats:ThresholdClass
 
 
 ├
stats:ThresholdDefinition
 
 
 
 ├
stats:Thr32Definition
 
 
 
 ├
stats:Thr64Definition
 
 
 
 ├
stats:ThrFloatDefinition
 
 
 ├
stats:ThresholdPolicy
 
 
 ├
stats:ThresholdValue
 
 
 
 ├
stats:Thr32Value
 
 
 
 ├
stats:Thr64Value
 
 
 
 ├
stats:ThrFloatValue
 
 
 ├
storage:ADef Base Connection Class
 
 
 
 ├
storage:ConnectionDef Policy used for specifying the target storage configuration. storage::ConnectionDef is created under storage::IniGroup, hence a local storage:ConnectionDef can be created for every IniGroup.
 
 
 
 ├
storage:ConnectionPolicy Policy used for specifying the target storage configuration. storage::ConnectionPolicy is created under Org.
 
 
 ├
storage:AuthKey
 
 
 ├
storage:IniGroup Initiator Group definition. This specifies the list of initiators that form a logical group for HA/Multipath purpose.
 
 
 ├
storage:Initiator Named initiator that participates in a storage IniGroup
 
 
 ├
storage:LocalDiskConfig
 
 
 
 ├
storage:LocalDiskConfigDef LocalDiskConfig
 
 
 
 ├
storage:LocalDiskConfigPolicy
 
 
 ├
sysdebug:MEpLogDef Abstraction of managed endpoint log policy These behaviors are controlled via specific subclasses.
 
 
 
 ├
sysdebug:MEpLogPolicy Abstraction of managed endpoint log configuration definition. Specifies configuration of log behavior on a given compute resource. MEpLogConfig configuration is optionally instantiated under logical server profile. mo name="MEpLogConfig" super="MEpLogDef" concrete="yes" access="admin,ls-config,ls-server,ls-policy,ls-compute" backup="yes" > ...
 
 
 ├
top:InfoSyncPolicy
 
 
 ├
trig:Inst An abstraction of a generalized system trigger.
 
 
 
 ├
trig:BaseSched Generic Scheduler. A user-defined schedule that can be used to trigger configuration at a specified date and time in the future. The schedule is defined in the system and can be referred by name from policies that require a schedule. For example, maintenance policies and firmware auto-install policies can refer to user-defined schedules. The schedule can have a list...
 
 
 
 
 ├
trig:LocalSched A locally defined user-defined schedule. The schedule is contained locally by the Managed Object that needs the schedule, as opposed to being referred by name.
 
 
 
 
 ├
trig:Sched A user-defined schedule that can be used to trigger configuration at a specified date and time in the future. The schedule is defined in the system and can be referred by name from policies that require a schedule. For example, maintenance policies and firmware auto-install policies can refer to user-defined schedules. The schedule can have a list of one-time occurrences and/or...
 
 
 
 ├
trig:Meta A system-generated Meta Scheduler. This object is automatically created by the system for every trig:BaseSched instance, and is added under top:System. The object is used to track the execution of the trig:BaseSched schedule. It keeps track of the last time the schedule was triggered and every job triggered by the schedule.
 
 
 ├
trig:Triggerable Triggerable object that must be triggered according to the schedule
 
 
 
 ├
fault:SuppressTask
 
 
 
 ├
firmware:Infra
 
 
 
 ├
mgmt:BackupPolicyConfig
 
 
 
 ├
trig:Ack
 
 
 
 
 ├
compute:FwSyncAck FwSyncAck object used by fw-auto-sync to get user's acknowledgement before triggering FwUpgrade
 
 
 
 
 ├
cpmaint:Ack Ack
 
 
 
 
 ├
firmware:Ack Ack object used by Install-All to get user's acknowledgement before rebooting primary FI
 
 
 
 
 ├
lsmaint:Ack Ack
 
 
 
 
 ├
trig:ConfAck
 
 
 
 
 
 ├
trig:ResAck
 
 
 
 ├
trig:Test
 
 
 ├
vm:Cont
 
 
 
 ├
vm:DirCont
 
 
 
 
 ├
vm:DC
 
 
 
 
 ├
vm:DCOrg
 
 
 
 ├
vm:Org
 
 
 
 ├
vm:Switch
 
 
 ├
vm:LifeCyclePolicy
 
 
 ├
vm:VnicProfCl A Port Profile Client is contained in a vnic:Profile and specifies the set of virtual switches where the port profile is deployed. A vnic:Profile Managed Object is a policy that specifies the characteristics of the port profile, such as QoS, PIN group and network control policy. However, vnic:Profile does not specify on which virtual switches the port profile should actuall...
 
 
 ├
vm:VnicProfInst
 
 
 ├
vnic:ABeh An abstract representation of a vnic behavior policy definition. Behavior policy definitions describe the vnics/vhbas (if any) that should be created for a service profile that contains no vnics/vhbas.
 
 
 
 ├
vnic:DefBeh A vnic behavior policy definition to apply to the containing service profile. Behavior policy definitions describe the vnics/vhbas (if any) that should be created for a service profile (ls::Server) that contains no vnics/vhbas. There may be at most 2 DefBeh created for a service profile - one for vnics and one for vhbas.
 
 
 
 ├
vnic:VhbaBehPolicy This is the top level (contained by root-org) vHBA behavior policy definition. It is applied to service profiles if: they have no vHBA; they have no DefBeh for the vHBA; There is a single VhbaBehPolicy objects created under root-org. These objects are user modifiable - not user createable.
 
 
 
 ├
vnic:VnicBehPolicy This is the top level (contained by root-org) vNIC behavior policy definition. It is applied to service profiles if: they have no vNIC; they have no DefBeh for the vNIC; There is a single VnicBehPolicy objects created under root-org. These objects are user modifiable - not user createable.
 
 
 ├
vnic:AGroup Vnic Group Base Class
 
 
 
 ├
vnic:FcGroupDef vHBA Group
 
 
 
 ├
vnic:FcGroupTempl
 
 
 ├
vnic:BootIpPolicy
 
 
 ├
vnic:ConReq
 
 
 
 ├
vnic:DynamicConReq Definition of dynamic connectivity resource space. This sace defines the number of vnics preallocated for dynamic use.
 
 
 
 
 ├
vnic:DynamicCon Specialization of Dynamic Connectivity Requirement. This sace defines the number of vnics preallocated for dynamic use. This object is contained logical server profile and treated as local definition.
 
 
 
 
 ├
vnic:DynamicConPolicy Specialization of Dynamic Connectivity Requirement. This sace defines the number of vnics preallocated for dynamic use. This object is contained by orgs and is name-referenced from the logical server profile.
 
 
 
 ├
vnic:UsnicConReq Definition of queue pair connectivity resource space. This space defines the number of usNIC preallocated for usNIC use.
 
 
 
 
 ├
vnic:UsnicConPolicy Specialization of usNIC Connectivity Requirement. This space defines the number of usNICs preallocated for usNIC use. This object is contained by orgs and is name-referenced from the logical server profile.
 
 
 
 ├
vnic:VmqConReq Definition of VMQ connectivity resource space. This space defines the number of VMQs preallocated for VMQ use.
 
 
 
 
 ├
vnic:VmqConPolicy Specialization of VMQ Connectivity Requirement. This space defines the number of VMQs preallocated for VMQ use. This object is contained by orgs and is name-referenced from the logical server profile.
 
 
 ├
vnic:DynamicIdUniverse
 
 
 ├
vnic:IScsiBootParams Contains the iSCSI boot configuration of a service profile.
 
 
 ├
vnic:IScsiBootVnic Identifies the vnic for iscsi boot and contains settings.
 
 
 ├
vnic:InitiatorAutoConfigPolicy
 
 
 
 ├
vnic:IScsiInitAutoConfigPolicy
 
 
 ├
vnic:InternalProfile InternalProfile is used for implicit profiles, user can not mutate these
 
 
 ├
vnic:LanConnPolicy This policy describes the network configuration that can be applied to a service profile. The network configuration would include mac address pool and vnics. It can be referenced from a vnicConnPolicy.
 
 
 ├
vnic:Profile A vnic profile is a policy applied to vnic/connectivity resources dynamically requested by a hypervisor. It defines: Connectivity rules by referring to a set of networks (VLANs) via contained {@link vnic:EtherIf} objects. Each contained {@link vnic:EtherIf} refers to a named VLAN. Qos policy binding Typically, a vn...
 
 
 ├
vnic:RackServerDiscoveryProfile RackServerDiscoveryProfile is used for profiles, user can not mutate these
 
 
 ├
vnic:SanConnPolicy This policy describes the storage configuration that can be applied to a service profile. The storage configuration would include wwn, wwpn, iscsi vnics and vhbas. It can be referenced from a vnicConnPolicy.
 
 
 ├
vnic:Templ
 
 
 
 ├
vnic:LanConnTempl A vNIC template is a policy that defines how a vNIC on a server connects to the LAN. You can bind a vNIC associated with a service profile to a vNIC template. When you bind the vNIC to a vNIC template, Cisco UCS Manager configures the vNIC with the values defined in the vNIC template. If the existing vNIC configuration does not match the vNIC template, Cisco UCS Manager reconfigures the vNIC. You can only chan...
 
 
 
 ├
vnic:SanConnTempl A vHBA template is a policy that defines how a vHBA on a server connects to the SAN. You can bind a vHBA associated with a service profile to a vHBA template. When you bind the vHBA to a vHBA template, Cisco UCS Manager configures the vHBA with the values defined in the vHBA template. If the existing vHBA configuration does not match the vHBA template, Cisco UCS Manager reconfigures the vHBA. You can only cha...
 
 ├
policy:Holder
 
 
 ├
event:Holder A container for event policy objects.
 
 
 ├
fault:BaseHolder Fault aggregation objects for holding the fault count by fault types
 
 
 
 ├
fault:Holder A container for fault policy objects
 
 
 
 ├
fault:LocalTypedHolder
 
 
 ├
org:Org
 
 
 ├
stats:Holder
 
 ├
rule:Item
 
 
 ├
networkrule:Item

Events
                



Faults
                



Fsms
                



Properties Summary
Defined in: policy:Object
naming:Name
          string:Basic
name  (policy:Object:name)
           Overrides:naming:NamedObject:name
           NO COMMENTS
Defined in: mo:TopProps
mo:ModificationChildAction
          scalar:Bitmask32
childAction  (mo:TopProps:childAction)
          
reference:Object dn  (mo:TopProps:dn)
           The Distinguished Name (dn) unambiguously identifies an object in the system.
The dn provides a fully qualified path from the top of the object tree, all the way to the object. It is built as a sequence of relative names separated by the "/" character.
For example:
< ... dn = "sys/chassis-5/blade-2/adaptor-1" />
reference:RN rn  (mo:TopProps:rn)
           The Relative Name (rn) uniquely identifies an object within a given context.
Note that a dn is comprised of a sequence of relative names. For example, the context "sys/chassis-1/blade-1/adaptor-1/host-eth-2" can be thought of as the following expression:
dn = <root object>/{rn}/{rn}/{rn}/{rn}/{rn}.
The rn can then be used to identify the object (for instance, "adaptor-1") within the context:
<... rn ="../" />
mo:InstSaclType
          scalar:Bitmask8
sacl  (mo:TopProps:sacl)
           The system acl property for each Managed Object. br/> This property is a 8 bit mask and supports the following values :-
a: del
b: mod
c: addchild
d: cascade

By default all Managed Objects have the following permissions
a: del
b: mod
c: addchild
This property is persisted in the db. If this property has a value none
it means, the user has read only permissions on this object.
mo:ModificationStatus
          scalar:Bitmask32
status  (mo:TopProps:status)
           This property controls the life cycle of a managed object

Properties Detail

childAction

Type: mo:ModificationChildAction
Primitive Type: scalar:Bitmask32
Units: null
Encrypted: false
Access: implicit
Category: TopLevelChildAction
Property Validators:
Comments:
Constants
deleteAll 16384u NO COMMENTS
ignore 4096u NO COMMENTS
deleteNonPresent 8192u NO COMMENTS
DEFAULT 0 This type is used to

dn

Type: reference:Object
Units: null
Encrypted: false
Access: implicit
Category: TopLevelDn
Property Validators:
Comments:
The Distinguished Name (dn) unambiguously identifies an object in the system.
The dn provides a fully qualified path from the top of the object tree, all the way to the object. It is built as a sequence of relative names separated by the "/" character.
For example:
< ... dn = "sys/chassis-5/blade-2/adaptor-1" />

name

Type: naming:Name
Primitive Type: string:Basic
Overrides:naming:NamedObject:name
Units: null
Encrypted: false
Access: admin
Category: TopLevelRegular
Property Validators:
    Range:  min: "0"  max: "16"
        Allowed Chars:
            Regex: [a-zA-Z0-9_.:-]+
Comments:
NO COMMENTS

rn

Type: reference:RN
Units: null
Encrypted: false
Access: implicit
Category: TopLevelRn
Property Validators:
Comments:
The Relative Name (rn) uniquely identifies an object within a given context.
Note that a dn is comprised of a sequence of relative names. For example, the context "sys/chassis-1/blade-1/adaptor-1/host-eth-2" can be thought of as the following expression:
dn = <root object>/{rn}/{rn}/{rn}/{rn}/{rn}.
The rn can then be used to identify the object (for instance, "adaptor-1") within the context:
<... rn ="../" />

sacl

Type: mo:InstSaclType
Primitive Type: scalar:Bitmask8
Units: null
Encrypted: false
Access: implicit
Category: TopLevelSacl
Property Validators:
Comments:
The system acl property for each Managed Object. br/> This property is a 8 bit mask and supports the following values :-
a: del
b: mod
c: addchild
d: cascade

By default all Managed Objects have the following permissions
a: del
b: mod
c: addchild
This property is persisted in the db. If this property has a value none
it means, the user has read only permissions on this object.
Constants
none 0 NO COMMENTS
del 1 NO COMMENTS
mod 2 NO COMMENTS
addchild 4 NO COMMENTS
cascade 8 NO COMMENTS
DEFAULT 0 NO COMMENTS

status

Type: mo:ModificationStatus
Primitive Type: scalar:Bitmask32
Units: null
Encrypted: false
Access: implicit
Category: TopLevelStatus
Property Validators:
Comments:
This property controls the life cycle of a managed object
Constants
removed 16u In a setter method: specifies that an object should be removed.
In the return value of a setter method: indicates that an object has been removed.
created 2u In a setter method: specifies that an object should be created. An error is returned if the object already exists.
In the return value of a setter method: indicates that an object has been created.
modified 4u In a setter method: specifies that an object should be modified
In the return value of a setter method: indicates that an object has been modified.
deleted 8u In a setter method: specifies that an object should be deleted.
In the return value of a setter method: indicates that an object has been deleted.
DEFAULT 0 This type controls the life cycle of objects passed in the XML API.

When used in a setter method (such as configConfMo), the ModificationStatus specifies whether an object should be created, modified, deleted or removed.
In the return value of a setter method, the ModificationStatus indicates the actual operation that was performed. For example, the ModificationStatus is set to "created" if the object was created. The ModificationStatus is not set if the object was neither created, modified, deleted or removed.

When invoking a setter method, the ModificationStatus is optional:
If a setter method such as configConfMo is invoked and the ModificationStatus is not set, the system automatically determines if the object should be created or modified.