Overview  Containers  Contained  Inheritance  Events  Faults  FSMs  Properties Summary  Properties Detail  Naming 

Class extpol:Client (CONCRETE)

Class ID:1356
Encrypted: false - Exportable: false - Persistent: true
Privileges: [admin]
SNMP OID: .1.3.6.1.4.1.9.9.719.1.42.1

NO COMMENTS

Naming Rules 
RN FORMAT: client-[id]

    [1] PREFIX=client- PROPERTY = id




DN FORMAT: 

[0] extpol/reg/clients/client-[id]


Containers Hierarchies
top:Root This class represents the root element in the object hierarchy. All managed objects in the system are descendants of the Root element.
 ├
 		extpol:Ep
 
 		 ├
 		extpol:Registry
 
 		 
 		 ├
 		extpol:ClientCont
 
 		 
 		 
 		 ├
 		extpol:Client


Contained Hierarchy
extpol:Client
 ├
 		fault:Inst An abnormal condition or defect at the component, equipment, or sub-system level which may lead to a failure, as defined in ISO/CD 10303-226.
 ├
 		observe:Observed Observed class encapsulates observed information
 
 		 ├
 		event:Inst
 
 		 ├
 		fault:Inst An abnormal condition or defect at the component, equipment, or sub-system level which may lead to a failure, as defined in ISO/CD 10303-226.
 
 		 ├
 		observe:Filter Filter class encapsulates filter information
 
 		 ├
 		observe:ObservedFsm
 
 		 
 		 ├
 		observe:ObservedFsmStage
 
 		 ├
 		observe:ObservedFsmTask
 ├
 		policy:PolicyScopeCont PolicyScopeCont class is to keep track of a policy provider and version for the resolved policy changes.
 
 		 ├
 		event:Inst
 
 		 ├
 		fault:Inst An abnormal condition or defect at the component, equipment, or sub-system level which may lead to a failure, as defined in ISO/CD 10303-226.
 
 		 ├
 		policy:ConfigError
 
 		 ├
 		policy:PolicyScopeContFsm
 
 		 
 		 ├
 		policy:PolicyScopeContFsmStage
 
 		 ├
 		policy:PolicyScopeContFsmTask
 
 		 ├
 		policy:PolicyScopeContext
 
 		 
 		 ├
 		policy:PolicyScope PolicyScope class is to keep track of context, policy class id and policy name in resolve-policy request, where the combination of context, policy class id and policy name is unique.
 
 		 
 		 
 		 ├
 		event:Inst
 
 		 
 		 
 		 ├
 		fault:Inst An abnormal condition or defect at the component, equipment, or sub-system level which may lead to a failure, as defined in ISO/CD 10303-226.
 
 		 
 		 
 		 ├
 		policy:PolicyRequestor PolicyRequestor class to keep track of policyName, onBehalfOfType, and onBehalfOfIdent for a resolve-policy request, where the policyName is unique.
 
 		 
 		 
 		 ├
 		policy:PolicyScopeFsm
 
 		 
 		 
 		 
 		 ├
 		policy:PolicyScopeFsmStage
 
 		 
 		 
 		 ├
 		policy:PolicyScopeFsmTask
Inheritance
extpol:Connector
 ├
 		extpol:Client
Events


Faults 
                extpol:Client:clientLostConnectivity

                extpol:Client:gracePeriodWarning

                extpol:Client:gracePeriodWarning1

                extpol:Client:gracePeriodWarning2

                extpol:Client:gracePeriodWarning3

                extpol:Client:gracePeriodWarning4

                extpol:Client:gracePeriodWarning5

                extpol:Client:gracePeriodWarning6

                extpol:Client:gracePeriodWarning7


Fsms


Properties Summary
Defined in: extpol:Client
naming:Descr
          string:Basic 		descr  (extpol:Client:descr)
           The description about this UCS system
extpol:GracePeriod
          scalar:Uint64 		gracePeriodUsed  (extpol:Client:gracePeriodUsed)
           Information about the time UCS is in grace period
string:Basic guid  (extpol:Client:guid)
           GUID of UCS system
extpol:InternalSysId
          scalar:Uint32 		id  (extpol:Client:id)
           Overrides:extpol:Connector:id
           NO COMMENTS
extpol:State
          scalar:Enum8 		licState  (extpol:Client:licState)
           Information about the current license state
naming:Name
          string:Basic 		owner  (extpol:Client:owner)
           The owner of this UCS system
naming:Name
          string:Basic 		site  (extpol:Client:site)
           The information about the site of this UCS system
extpol:SuspendState
          scalar:Enum8 		suspendState  (extpol:Client:suspendState)
           Flag to mark suspension of updates from UCS Central
Defined in: extpol:Connector
extpol:AppCapability
          scalar:Bitmask64 		capability  (extpol:Connector:capability)
           NO COMMENTS
extpol:ConnProtocol
          scalar:Enum8 		connProtocol  (extpol:Connector:connProtocol)
           NO COMMENTS
address:HostNameOrDottedQuad
          string:Basic 		host  (extpol:Connector:host)
           NO COMMENTS
extpol:AppCapability
          scalar:Bitmask64 		interest  (extpol:Connector:interest)
           NO COMMENTS
address:IPv4 ip  (extpol:Connector:ip)
           NO COMMENTS
address:IPv6 ipv6  (extpol:Connector:ipv6)
           NO COMMENTS
scalar:Date lastPollTs  (extpol:Connector:lastPollTs)
           NO COMMENTS
extpol:SystemName
          string:Basic 		name  (extpol:Connector:name)
           NO COMMENTS
extpol:ConnectorOperState
          scalar:Enum8 		operState  (extpol:Connector:operState)
           NO COMMENTS
extpol:ConnType type  (extpol:Connector:type)
           NO COMMENTS
version:Version
          string:Basic 		version  (extpol:Connector:version)
           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

capability

Type: extpol:AppCapability
Primitive Type: scalar:Bitmask64
Units: null
Encrypted: false
Access: implicit
Category: TopLevelRegular
Property Validators:

Comments:
NO COMMENTS
Constants
unspecified 0ull NO COMMENTS
vmm 1024ull NO COMMENTS
infra-waf 1048576ull NO COMMENTS
vm-mgr 128ull NO COMMENTS
pcm 131072ull NO COMMENTS
infra-fw 16384ull NO COMMENTS
org-mgr 16777216ull Capability to create/udpate/delete org and propagate the orgs to others as service-reg
virtual-switching-mgr 16ull NO COMMENTS
service-reg 1ull The followings are provider types
vm-vasw 2048ull Virtual Access Switch
infra-pasw 2097152ull NO COMMENTS
vm-admin 256ull The followings are specific controller types
infra-aggr 262144ull NO COMMENTS
identifier-mgr 2ull NO COMMENTS
infra-slb 32768ull NO COMMENTS
policy-mgr 32ull NO COMMENTS
stats-mgr 33554432ull NO COMMENTS
vm-fw 4096ull VM virtual firewall
infra-pdsw 4194304ull NO COMMENTS
operation-mgr 4ull NO COMMENTS
infra-crypto-offloa 512ull The followings are specific client types
infra-was 524288ull NO COMMENTS
boot-mgr 64ull NO COMMENTS
ipam 65536ull NO COMMENTS
central-mgr 67108864ull NO COMMENTS
vm-slb 8192ull NO COMMENTS
storage-broker 8388608ull NO COMMENTS
resource-mgr 8ull NO COMMENTS
DEFAULT unspecified(0ull) NO COMMENTS

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

connProtocol

Type: extpol:ConnProtocol
Primitive Type: scalar:Enum8
Units: null
Encrypted: false
Access: implicit
Category: TopLevelRegular
Property Validators:

Comments:
NO COMMENTS
Constants
ipv4 0 NO COMMENTS
ipv6 1 NO COMMENTS
unknown 2 NO COMMENTS
DEFAULT unknown(2) NO COMMENTS

descr

Type: naming:Descr
Primitive Type: string:Basic
Units: null
Encrypted: false
Access: implicit
Category: TopLevelRegular
Property Validators:
    Range:  min: "0"  max: "256"
        Allowed Chars:
            Regex: [a-zA-Z0-9\[\]!#$%()*+,-./:;@ _{|}˜?&]+

Comments:
The description about this UCS system

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" />

gracePeriodUsed

Type: extpol:GracePeriod
Primitive Type: scalar:Uint64
Units: null
Encrypted: false
Access: implicit
Category: TopLevelRegular
Property Validators:

Comments:
Information about the time UCS is in grace period

guid

Type: string:Basic
Units: null
Encrypted: false
Access: implicit
Category: TopLevelRegular
Property Validators:
    Range:  min: "0"  max: "510"

Comments:
GUID of UCS system

host

Type: address:HostNameOrDottedQuad
Primitive Type: string:Basic
Units: null
Encrypted: false
Access: implicit
Category: TopLevelRegular
Property Validators:
    Range:  min: "256"  max: "4096" (EXCLUDE)
    Regex: ˆ[A-Za-z]([A-Za-z0-9-]*[A-Za-z0-9])?$|ˆ[A-Za-z0-9]([A-Za-z0-9-]*[A-Za-z0-9])?(\.[A-Za-z0-9]([A-Za-z0-9-]*[A-Za-z0-9])?)*(\.[A-Za-z]([A-Za-z0-9-]*[A-Za-z0-9])?)$|ˆ([1-9]|[1-9][0-9]|1[0-9][0-9]|2[0-4][0-9]|25[0-5])\.([0-9]|[1-9][0-9]|1[0-9][0-9]|2[0-4][0-9]|25[0-5])\.([0-9]|[1-9][0-9]|1[0-9][0-9]|2[0-4][0-9]|25[0-5])\.([1-9]|[1-9][0-9]|1[0-9][0-9]|2[0-4][0-9]|25[0-5])$

Comments:
NO COMMENTS

id

Type: extpol:InternalSysId
Primitive Type: scalar:Uint32
Overrides:extpol:Connector:id
Units: null
Encrypted: false
Naming Property -- [NAMING RULES]
Access: naming
Category: TopLevelRegular
Property Validators:

Comments:
NO COMMENTS

interest

Type: extpol:AppCapability
Primitive Type: scalar:Bitmask64
Units: null
Encrypted: false
Access: implicit
Category: TopLevelRegular
Property Validators:

Comments:
NO COMMENTS
Constants
unspecified 0ull NO COMMENTS
vmm 1024ull NO COMMENTS
infra-waf 1048576ull NO COMMENTS
vm-mgr 128ull NO COMMENTS
pcm 131072ull NO COMMENTS
infra-fw 16384ull NO COMMENTS
org-mgr 16777216ull Capability to create/udpate/delete org and propagate the orgs to others as service-reg
virtual-switching-mgr 16ull NO COMMENTS
service-reg 1ull The followings are provider types
vm-vasw 2048ull Virtual Access Switch
infra-pasw 2097152ull NO COMMENTS
vm-admin 256ull The followings are specific controller types
infra-aggr 262144ull NO COMMENTS
identifier-mgr 2ull NO COMMENTS
infra-slb 32768ull NO COMMENTS
policy-mgr 32ull NO COMMENTS
stats-mgr 33554432ull NO COMMENTS
vm-fw 4096ull VM virtual firewall
infra-pdsw 4194304ull NO COMMENTS
operation-mgr 4ull NO COMMENTS
infra-crypto-offloa 512ull The followings are specific client types
infra-was 524288ull NO COMMENTS
boot-mgr 64ull NO COMMENTS
ipam 65536ull NO COMMENTS
central-mgr 67108864ull NO COMMENTS
vm-slb 8192ull NO COMMENTS
storage-broker 8388608ull NO COMMENTS
resource-mgr 8ull NO COMMENTS
DEFAULT unspecified(0ull) NO COMMENTS

ip

Type: address:IPv4
Units: null
Encrypted: false
Access: implicit
Category: TopLevelRegular
Property Validators:

Comments:
NO COMMENTS

ipv6

Type: address:IPv6
Units: null
Encrypted: false
Access: implicit
Category: TopLevelRegular
Property Validators:

Comments:
NO COMMENTS

lastPollTs

Type: scalar:Date
Units: null
Encrypted: false
Access: implicit
Category: TopLevelRegular
Property Validators:

Comments:
NO COMMENTS

licState

Type: extpol:State
Primitive Type: scalar:Enum8
Units: null
Encrypted: false
Access: implicit
Category: TopLevelRegular
Property Validators:

Comments:
Information about the current license state
Constants
unknown 0 NO COMMENTS
license-ok 1 NO COMMENTS
license-insufficient 2 NO COMMENTS
license-graceperiod 3 NO COMMENTS
license-expired 4 NO COMMENTS
not-applicable 5 NO COMMENTS
DEFAULT unknown(0) NO COMMENTS

name

Type: extpol:SystemName
Primitive Type: string:Basic
Units: null
Encrypted: false
Access: implicit
Category: TopLevelRegular
Property Validators:
    Range:  min: "0"  max: "510"

Comments:
NO COMMENTS

operState

Type: extpol:ConnectorOperState
Primitive Type: scalar:Enum8
Units: null
Encrypted: false
Access: implicit
Category: TopLevelRegular
Property Validators:

Comments:
NO COMMENTS
Constants
unregistered 0 NO COMMENTS
lost-visibility 1 NO COMMENTS
registering 2 NO COMMENTS
synchronizing 3 NO COMMENTS
registered 4 NO COMMENTS
version-mismatch 5 NO COMMENTS
registry-not-reachable 6 NO COMMENTS
DEFAULT registered(4) NO COMMENTS

owner

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

Comments:
The owner of this UCS system

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

site

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

Comments:
The information about the site of this UCS system

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.

suspendState

Type: extpol:SuspendState
Primitive Type: scalar:Enum8
Units: null
Encrypted: false
Access: implicit
Category: TopLevelRegular
Property Validators:

Comments:
Flag to mark suspension of updates from UCS Central
Constants
off 0 NO COMMENTS
on 1 NO COMMENTS
DEFAULT off(0) NO COMMENTS

type

Type: extpol:ConnType
Units: null
Encrypted: false
Access: implicit
Category: TopLevelRegular
Property Validators:

Comments:
NO COMMENTS
Constants
service-reg 27u NO COMMENTS
identifier-mgr 28u NO COMMENTS
operation-mgr 29u NO COMMENTS
resource-mgr 30u NO COMMENTS
virtual-switching-mgr 31u NO COMMENTS
policy-mgr 32u NO COMMENTS
boot-mgr 33u NO COMMENTS
vm-mgr 34u NO COMMENTS
managed-endpoint 35u NO COMMENTS
mgmt-controller 36u NO COMMENTS
storage-broker 37u NO COMMENTS
resource-aggr 38u NO COMMENTS
stats-mgr 39u NO COMMENTS
central-mgr 40u NO COMMENTS
ape 5u NO COMMENTS
DEFAULT 5 NO COMMENTS

version

Type: version:Version
Primitive Type: string:Basic
Units: null
Encrypted: false
Access: implicit
Category: TopLevelRegular
Property Validators:
    Range:  min: "0"  max: "510"

Comments:
NO COMMENTS
Overview  Containers  Contained  Inheritance  Events  Faults  FSMs  Properties Summary  Properties Detail  Naming