Overview  Diagram  Inheritance  Events  Faults  FSMs  Properties Summary  Properties Detail 

Class cloud:ARuleAction (ABSTRACT)

Class ID:15182
Class Label: Abstract Cloud Load Balancer Listener Rule Action
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-device, nw-svc-policy]
Read Access: [admin, nw-svc-device, 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: pol:Def,
Sub Mos: cloud:RuleAction, cloud:RuleActionDef, cloud:RuleActionRef,


Inheritance
[V] naming:NamedObject An abstract base class for an object that contains a name.
 ├
 		[V] pol:Obj Represents a generic policy object.
 
 		 ├
 		[V] pol:Def Represents self-contained policy document.
 
 		 
 		 ├
 		[V] cloud:ARuleAction 
 
 		 
 		 
 		 ├
 		[V] cloud:RuleAction 
 
 		 
 		 
 		 ├
 		[V] cloud:RuleActionDef 
 
 		 
 		 
 		 ├
 		[V] cloud:RuleActionRef 


Events


Faults


Fsms


Properties Summary
Defined in: cloud:ARuleAction
string:Basic FixedResponseBody  (cloud:ARuleAction:FixedResponseBody)
           NO COMMENTS
string:Basic FixedResponseCode  (cloud:ARuleAction:FixedResponseCode)
           NO COMMENTS
cloud:FixedResponseContentType
          scalar:Enum8 		FixedResponseContentType  (cloud:ARuleAction:FixedResponseContentType)
           NO COMMENTS
cloud:RedirectCode
          scalar:Enum16 		RedirectCode  (cloud:ARuleAction:RedirectCode)
           NO COMMENTS
string:Basic RedirectHostname  (cloud:ARuleAction:RedirectHostname)
           NO COMMENTS
string:Basic RedirectPath  (cloud:ARuleAction:RedirectPath)
           NO COMMENTS
string:Basic RedirectPort  (cloud:ARuleAction:RedirectPort)
           NO COMMENTS
cloud:RedirectProtocol
          scalar:Enum8 		RedirectProtocol  (cloud:ARuleAction:RedirectProtocol)
           NO COMMENTS
string:Basic RedirectQuery  (cloud:ARuleAction:RedirectQuery)
           NO COMMENTS
reference:BinRef epgdn  (cloud:ARuleAction:epgdn)
           NO COMMENTS
scalar:Uint16 port  (cloud:ARuleAction:port)
           The service port number for the LDAP service.
cloud:ListenerPoolProtocol
          scalar:Enum8 		protocol  (cloud:ARuleAction:protocol)
           The transfer protocol to be used for data export.
cloud:ActionType
          scalar:Enum8 		type  (cloud:ARuleAction:type)
           The specific type of the object or component.
Defined in: pol:Def
naming:Descr
          string:Basic 		descr  (pol:Def:descr)
           Specifies a description of the policy definition.
naming:Descr
          string:Basic 		ownerKey  (pol:Def:ownerKey)
           The key for enabling clients to own their data for entity correlation.
naming:Descr
          string:Basic 		ownerTag  (pol:Def:ownerTag)
           A tag for enabling clients to add their own data. For example, to indicate who created this object.
Defined in: pol:Obj
naming:Name
          string:Basic 		name  (pol:Obj:name)
           Overrides:naming:NamedObject:name
           null
Defined in: naming:NamedObject
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

FixedResponseBody

Type: string:Basic

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


FixedResponseCode

Type: string:Basic

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


FixedResponseContentType

Type: cloud:FixedResponseContentType
Primitive Type: scalar:Enum8

Units: null
Encrypted: false
Access: admin
Category: TopLevelRegular
Property Validators:
    Comments:
NO COMMENTS
Constants
textPlain 0 text/plain NO COMMENTS
textCSS 1 text/css NO COMMENTS
textHtml 2 text/html NO COMMENTS
appJS 3 application/javascript NO COMMENTS
appJson 4 application/json NO COMMENTS
DEFAULT textPlain(0) text/plain NO COMMENTS




RedirectCode

Type: cloud:RedirectCode
Primitive Type: scalar:Enum16

Units: null
Encrypted: false
Access: admin
Category: TopLevelRegular
Property Validators:
    Comments:
NO COMMENTS
Constants
permMoved 0 Permanently moved(301) NO COMMENTS
found 1 Found(302) NO COMMENTS
DEFAULT permMoved(0) Permanently moved(301) NO COMMENTS




RedirectHostname

Type: string:Basic

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


RedirectPath

Type: string:Basic

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


RedirectPort

Type: string:Basic

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


RedirectProtocol

Type: cloud:RedirectProtocol
Primitive Type: scalar:Enum8

Units: null
Encrypted: false
Access: admin
Category: TopLevelRegular
Property Validators:
    Comments:
NO COMMENTS
Constants
inherit 0 inherit NO COMMENTS
http 1 HTTP NO COMMENTS
https 2 HTTPS NO COMMENTS
DEFAULT inherit(0) inherit NO COMMENTS




RedirectQuery

Type: string:Basic

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


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




descr

Type: naming:Descr
Primitive Type: string:Basic

Like: naming:Described:descr
Units: null
Encrypted: false
Access: admin
Category: TopLevelRegular
Property Validators:
    Range:  min: "0"  max: "128"
        Allowed Chars:
            Regex: [a-zA-Z0-9\\!#$%()*,-./:;@ _{|}~?&+]+
    Comments:
Specifies a description of the policy definition.


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.


epgdn

Type: reference:BinRef

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


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: "64"
        Allowed Chars:
            Regex: [a-zA-Z0-9_.:-]+
    Comments:
null


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


ownerKey

Type: naming:Descr
Primitive Type: string:Basic

Units: null
Encrypted: false
Access: admin
Category: TopLevelRegular
Property Validators:
    Range:  min: "0"  max: "128"
        Allowed Chars:
            Regex: [a-zA-Z0-9\\!#$%()*,-./:;@ _{|}~?&+]+
    Comments:
The key for enabling clients to own their data for entity correlation.


ownerTag

Type: naming:Descr
Primitive Type: string:Basic

Units: null
Encrypted: false
Access: admin
Category: TopLevelRegular
Property Validators:
    Range:  min: "0"  max: "64"
        Allowed Chars:
            Regex: [a-zA-Z0-9\\!#$%()*,-./:;@ _{|}~?&+]+
    Comments:
A tag for enabling clients to add their own data. For example, to indicate who created this object.


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
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.





type

Type: cloud:ActionType
Primitive Type: scalar:Enum8

Units: null
Encrypted: false
Access: admin
Category: TopLevelRegular
Property Validators:
    Comments:
The specific type of the object or component.
Constants
forward 0 Forward NO COMMENTS
redirect 1 Redirect NO COMMENTS
fixedResponse 2 Return fixed response NO COMMENTS
DEFAULT forward(0) Forward NO COMMENTS






Overview  Diagram  Inheritance  Events  Faults  FSMs  Properties Summary  Properties Detail