Overview  Diagram  Inheritance  Events  Faults  FSMs  Properties Summary  Properties Detail 

Class cloud:APool (ABSTRACT)

Class ID:15172
Class Label: Abstract Cloud Load Balancer Backend Pool
Encrypted: false - Exportable: true - Persistent: true - Configurable: true - Subject to Quota: Disabled - Abstraction Layer: Concrete Model - APIC NX Processing: Disabled
Write Access: [admin, nw-svc-policy]
Read Access: [admin, nw-svc-policy]
Creatable/Deletable: derived (see Container Mos for details)
Possible Semantic Scopes: EPG, Fabric,
Semantic Scope Evaluation Rule: Subclasses
Monitoring Policy Source: Parent
Monitoring Flags : [ IsObservable: false, HasStats: false, HasFaults: false, HasHealth: false, HasEventRules: false ]

NO COMMENTS

Naming Rules 


DN FORMAT:


Diagram

Super Mo: naming:NamedObject,
Sub Mos: cloud:PoolDef,


Inheritance
[V] naming:NamedObject An abstract base class for an object that contains a name.
 ├
 		[V] cloud:APool 
 
 		 ├
 		[V] cloud:PoolDef 


Events


Faults


Fsms


Properties Summary
Defined in: cloud:APool
string:Basic healthHost  (cloud:APool:healthHost)
           NO COMMENTS
scalar:Uint16 healthInterval  (cloud:APool:healthInterval)
           NO COMMENTS
string:Basic healthPath  (cloud:APool:healthPath)
           NO COMMENTS
scalar:Bool healthPickHostNameFromBackendHTTPSetting  (cloud:APool:healthPickHostNameFromBackendHTTPSetting)
           NO COMMENTS
scalar:Uint16 healthPort  (cloud:APool:healthPort)
           NO COMMENTS
string:Basic healthProbeName  (cloud:APool:healthProbeName)
           NO COMMENTS
cloud:ListenerPoolProtocol
          scalar:Enum8 		healthProtocol  (cloud:APool:healthProtocol)
           NO COMMENTS
string:Basic healthSuccessCode  (cloud:APool:healthSuccessCode)
           NO COMMENTS
scalar:Uint16 healthTimeout  (cloud:APool:healthTimeout)
           NO COMMENTS
scalar:Uint16 healthUnhealthyThreshold  (cloud:APool:healthUnhealthyThreshold)
           NO COMMENTS
scalar:Uint16 port  (cloud:APool:port)
           The service port number for the LDAP service.
cloud:ListenerPoolProtocol
          scalar:Enum8 		protocol  (cloud:APool:protocol)
           The transfer protocol to be used for data export.
Defined in: naming:NamedObject
naming:Name
          string:Basic 		name  (naming:NamedObject:name)
           The name of the object.
naming:NameAlias
          string:Basic 		nameAlias  (naming:NamedObject:nameAlias)
           NO COMMENTS
Defined in: mo:TopProps
mo:ModificationChildAction
          scalar:Bitmask32 		childAction  (mo:TopProps:childAction)
           Delete or ignore. For internal use only.
reference:BinRef dn  (mo:TopProps:dn)
           A tag or metadata is a non-hierarchical keyword or term assigned to the fabric module.
reference:BinRN rn  (mo:TopProps:rn)
           Identifies an object from its siblings within the context of its parent object. The distinguished name contains a sequence of relative names.
mo:ModificationStatus
          scalar:Bitmask32 		status  (mo:TopProps:status)
           The upgrade status. This property is for internal use only.
Properties Detail

childAction

Type: mo:ModificationChildAction
Primitive Type: scalar:Bitmask32

Units: null
Encrypted: false
Access: implicit
Category: TopLevelChildAction
    Comments:
Delete or ignore. For internal use only.
Constants
deleteAll 16384u deleteAll NO COMMENTS
ignore 4096u ignore NO COMMENTS
deleteNonPresent 8192u deleteNonPresent NO COMMENTS
DEFAULT 0 --- This type is used to




dn

Type: reference:BinRef

Units: null
Encrypted: false
Access: implicit
Category: TopLevelDn
    Comments:
A tag or metadata is a non-hierarchical keyword or term assigned to the fabric module.


healthHost

Type: string:Basic

Units: null
Encrypted: false
Access: admin
Category: TopLevelRegular
Property Validators:
    Range:  min: "0"  max: "512"
    Comments:
NO COMMENTS


healthInterval

Type: scalar:Uint16

Units: null
Encrypted: false
Access: admin
Category: TopLevelRegular
Property Validators:
    Comments:
NO COMMENTS


healthPath

Type: string:Basic

Units: null
Encrypted: false
Access: admin
Category: TopLevelRegular
Property Validators:
    Range:  min: "0"  max: "512"
    Comments:
NO COMMENTS


healthPickHostNameFromBackendHTTPSetting

Type: scalar:Bool

Units: null
Encrypted: false
Access: admin
Category: TopLevelRegular
Property Validators:
    Comments:
NO COMMENTS
Constants
no false --- NO COMMENTS
yes true --- NO COMMENTS
DEFAULT no(false) --- NO COMMENTS




healthPort

Type: scalar:Uint16

Units: null
Encrypted: false
Access: admin
Category: TopLevelRegular
Property Validators:
    Comments:
NO COMMENTS


healthProbeName

Type: string:Basic

Units: null
Encrypted: false
Access: admin
Category: TopLevelRegular
Property Validators:
    Range:  min: "0"  max: "512"
    Comments:
NO COMMENTS


healthProtocol

Type: cloud:ListenerPoolProtocol
Primitive Type: scalar:Enum8

Units: null
Encrypted: false
Access: admin
Category: TopLevelRegular
Property Validators:
    Comments:
NO COMMENTS
Constants
http 0 HTTP NO COMMENTS
https 1 HTTPS NO COMMENTS
tcp 2 TCP NO COMMENTS
udp 3 UDP NO COMMENTS
tls 4 TLS NO COMMENTS
DEFAULT http(0) HTTP NO COMMENTS




healthSuccessCode

Type: string:Basic

Units: null
Encrypted: false
Access: admin
Category: TopLevelRegular
Property Validators:
    Range:  min: "0"  max: "512"
    Comments:
NO COMMENTS


healthTimeout

Type: scalar:Uint16

Units: null
Encrypted: false
Access: admin
Category: TopLevelRegular
Property Validators:
    Comments:
NO COMMENTS


healthUnhealthyThreshold

Type: scalar:Uint16

Units: null
Encrypted: false
Access: admin
Category: TopLevelRegular
Property Validators:
    Comments:
NO COMMENTS


name

Type: naming:Name
Primitive Type: string:Basic

Like: naming:Named:name
Units: null
Encrypted: false
Access: admin
Category: TopLevelRegular
Property Validators:
    Range:  min: "0"  max: "16"
        Allowed Chars:
            Regex: [a-zA-Z0-9_.:-]+
    Comments:
The name of the object.


nameAlias

Type: naming:NameAlias
Primitive Type: string:Basic

Units: null
Encrypted: false
Access: admin
Category: TopLevelRegular
Property Validators:
    Range:  min: "0"  max: "63"
        Allowed Chars:
            Regex: [a-zA-Z0-9_.-]+
    Comments:
NO COMMENTS


port

Type: scalar:Uint16

Units: null
Encrypted: false
Access: admin
Category: TopLevelRegular
Property Validators:
    Comments:
The service port number for the LDAP service.


protocol

Type: cloud:ListenerPoolProtocol
Primitive Type: scalar:Enum8

Units: null
Encrypted: false
Access: admin
Category: TopLevelRegular
Property Validators:
    Comments:
The transfer protocol to be used for data export.
Constants
http 0 HTTP NO COMMENTS
https 1 HTTPS NO COMMENTS
tcp 2 TCP NO COMMENTS
udp 3 UDP NO COMMENTS
tls 4 TLS NO COMMENTS
DEFAULT http(0) HTTP NO COMMENTS




rn

Type: reference:BinRN

Units: null
Encrypted: false
Access: implicit
Category: TopLevelRn
    Comments:
Identifies an object from its siblings within the context of its parent object. The distinguished name contains a sequence of relative names.


status

Type: mo:ModificationStatus
Primitive Type: scalar:Bitmask32

Units: null
Encrypted: false
Access: implicit
Category: TopLevelStatus
    Comments:
The upgrade status. This property is for internal use only.
Constants
created 2u created 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 modified 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 deleted 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.







Overview  Diagram  Inheritance  Events  Faults  FSMs  Properties Summary  Properties Detail