Class cloud:RuleActionDef (CONCRETE)

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

NO COMMENTS

Naming Rules
RN FORMAT: actiondef-{type}

    [1] PREFIX=actiondef- PROPERTY = type




DN FORMAT: 

[1] uni/svcdefcont/tensvcdef-{name}/ldevdef-{[lDevDn]}/svcpolicydef/listenerdef-{name}/lisRuleDef-{name}/actiondef-{type}

[3] uni/tn-{name}/ldevdef-{[lDevDn]}/svcpolicydef/listenerdef-{name}/lisRuleDef-{name}/actiondef-{type}

                


Diagram

Super Mo: cloud:ARuleAction,
Container Mos: cloud:ListenerRuleDef (deletable:yes),
Relations To: cloud:PoolDef,
Relations: cloud:RsActionDefToPoolDef,


Containers Hierarchies
[V] top:Root  This class represents the root element in the object hierarchy. All managed objects in the system are descendants of the Root element.
 ├
[V] fabric:Topology The root for IFC topology.
 
 ├
[V] fabric:Pod A pod.
 
 
 ├
[V] fabric:Node The root node for the APIC.
 
 
 
 ├
[V] ctx:Local The local Context.
 
 
 
 
 ├
[V] ctx:Application The context application.
 
 
 
 
 
 ├
[V] pol:Uni Represents policy definition/resolution universe.
 
 
 
 
 
 
 ├
[V] cloud:SvcDefCont 
 
 
 
 
 
 
 
 ├
[V] cloud:TenantSvcDef 
 
 
 
 
 
 
 
 
 ├
[V] cloud:LDevDef 
 
 
 
 
 
 
 
 
 
 ├
[V] cloud:SvcPolicyDef 
 
 
 
 
 
 
 
 
 
 
 ├
[V] cloud:ListenerDef 
 
 
 
 
 
 
 
 
 
 
 
 ├
[V] cloud:ListenerRuleDef 
 
 
 
 
 
 
 
 
 
 
 
 
 ├
[V] cloud:RuleActionDef 
[V] top:Root  This class represents the root element in the object hierarchy. All managed objects in the system are descendants of the Root element.
 ├
[V] pol:Uni Represents policy definition/resolution universe.
 
 ├
[V] cloud:SvcDefCont 
 
 
 ├
[V] cloud:TenantSvcDef 
 
 
 
 ├
[V] cloud:LDevDef 
 
 
 
 
 ├
[V] cloud:SvcPolicyDef 
 
 
 
 
 
 ├
[V] cloud:ListenerDef 
 
 
 
 
 
 
 ├
[V] cloud:ListenerRuleDef 
 
 
 
 
 
 
 
 ├
[V] cloud:RuleActionDef 
[V] top:Root  This class represents the root element in the object hierarchy. All managed objects in the system are descendants of the Root element.
 ├
[V] fabric:Topology The root for IFC topology.
 
 ├
[V] fabric:Pod A pod.
 
 
 ├
[V] fabric:Node The root node for the APIC.
 
 
 
 ├
[V] ctx:Local The local Context.
 
 
 
 
 ├
[V] ctx:Application The context application.
 
 
 
 
 
 ├
[V] pol:Uni Represents policy definition/resolution universe.
 
 
 
 
 
 
 ├
[V] fv:Tenant A policy owner in the virtual fabric. A tenant can be either a private or a shared entity. For example, you can create a tenant with contexts and bridge domains shared by other tenants. A shared type of tenant is typically named common, default, or infra.
 
 
 
 
 
 
 
 ├
[V] cloud:LDevDef 
 
 
 
 
 
 
 
 
 ├
[V] cloud:SvcPolicyDef 
 
 
 
 
 
 
 
 
 
 ├
[V] cloud:ListenerDef 
 
 
 
 
 
 
 
 
 
 
 ├
[V] cloud:ListenerRuleDef 
 
 
 
 
 
 
 
 
 
 
 
 ├
[V] cloud:RuleActionDef 
[V] top:Root  This class represents the root element in the object hierarchy. All managed objects in the system are descendants of the Root element.
 ├
[V] pol:Uni Represents policy definition/resolution universe.
 
 ├
[V] fv:Tenant A policy owner in the virtual fabric. A tenant can be either a private or a shared entity. For example, you can create a tenant with contexts and bridge domains shared by other tenants. A shared type of tenant is typically named common, default, or infra.
 
 
 ├
[V] cloud:LDevDef 
 
 
 
 ├
[V] cloud:SvcPolicyDef 
 
 
 
 
 ├
[V] cloud:ListenerDef 
 
 
 
 
 
 ├
[V] cloud:ListenerRuleDef 
 
 
 
 
 
 
 ├
[V] cloud:RuleActionDef 


Contained Hierarchy
[V] cloud:RuleActionDef 
 ├
[V] cloud:RsActionDefToPoolDef 
 
 ├
[V] aaa:RbacAnnotation  RbacAnnotation is used for capturing rbac properties of any apic object Objects can append rbacannotations as Object->RbacAnnotation which is then checked for domain eligibility
 
 ├
[V] fault:Counts An immutable object that provides the number of critical, major, minor, and warning faults raised on its parent object and its subtree.
 
 ├
[V] fault:Inst Contains detailed information of a fault. This object is attached as a child of the object on which the fault condition occurred. One instance object is created for each fault condition of the parent object. A fault instance object is identified by a fault code.
 
 
 ├
[V] aaa:RbacAnnotation  RbacAnnotation is used for capturing rbac properties of any apic object Objects can append rbacannotations as Object->RbacAnnotation which is then checked for domain eligibility
 
 
 ├
[V] tag:Annotation 
 
 
 ├
[V] tag:Tag 
 
 ├
[V] health:Inst A base class for a health score instance.(Switch only)
 
 ├
[V] tag:Annotation 
 
 ├
[V] tag:Tag 
 ├
[V] fault:Counts An immutable object that provides the number of critical, major, minor, and warning faults raised on its parent object and its subtree.
 ├
[V] fault:Delegate Exposes internal faults to the user. A fault delegate object can be defined on IFC (for example, for an endpoint group) and when the fault is raised (for example, under an endpoint policy on a switch), a fault delegate object is created on IFC under the specified object. A fault delegate object follows the lifecycle of the original fault instance object, being created, modified, or deleted based on the changes of the original fault.
 ├
[V] health:Inst A base class for a health score instance.(Switch only)


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:RuleActionDef 


Events
                


Faults
                


Fsms
                


Properties Summary
Defined in: cloud:RuleActionDef
reference:BinRef monPolDn  (cloud:RuleActionDef:monPolDn)
           The monitoring policy attached to this observable object.
cloud:ActionType
          scalar:Enum8
type  (cloud:RuleActionDef:type)
           Overrides:cloud:ARuleAction:type
           The specific type of the object or component.
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
string:Basic healthProbe  (cloud:ARuleAction:healthProbe)
           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.
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:Resolvable
mo:Owner
          scalar:Enum8
lcOwn  (mo:Resolvable:lcOwn)
           A value that indicates how this object was created. For internal use only.
Defined in: mo:Modifiable
mo:TStamp
          scalar:Date
modTs  (mo:Modifiable:modTs)
           The time when this object was last modified.
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
    Comments:
NO COMMENTS



FixedResponseCode

Type: string:Basic

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



FixedResponseContentType

Type: cloud:FixedResponseContentType
Primitive Type: scalar:Enum8

Units: null
Encrypted: false
Access: admin
Category: TopLevelRegular
    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
    Comments:
NO COMMENTS
Constants
permMoved 0 Permanently moved(301) NO COMMENTS
found 1 Found(302) NO COMMENTS
seeOther 2 SeeOther(303) NO COMMENTS
temporary 3 Temporary(307) NO COMMENTS
DEFAULT permMoved(0) Permanently moved(301) NO COMMENTS





RedirectHostname

Type: string:Basic

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



RedirectPath

Type: string:Basic

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



RedirectPort

Type: string:Basic

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



RedirectProtocol

Type: cloud:RedirectProtocol
Primitive Type: scalar:Enum8

Units: null
Encrypted: false
Access: admin
Category: TopLevelRegular
    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
    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
    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
    Comments:
NO COMMENTS



healthProbe

Type: string:Basic

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



lcOwn

Type: mo:Owner
Primitive Type: scalar:Enum8

Units: null
Encrypted: false
Access: implicit
Category: TopLevelRegular
    Comments:
A value that indicates how this object was created. For internal use only.
Constants
local 0 Local NO COMMENTS
policy 1 Policy NO COMMENTS
replica 2 Replica NO COMMENTS
resolveOnBehalf 3 ResolvedOnBehalf NO COMMENTS
implicit 4 Implicit NO COMMENTS
DEFAULT local(0) Local NO COMMENTS





modTs

Type: mo:TStamp
Primitive Type: scalar:Date

Units: null
Encrypted: false
Access: implicit
Category: TopLevelRegular
    Comments:
The time when this object was last modified.
Constants
never 0ull never NO COMMENTS
DEFAULT never(0ull) never NO COMMENTS





monPolDn

Type: reference:BinRef

Units: null
Encrypted: false
Access: implicit
Category: TopLevelRegular
    Comments:
The monitoring policy attached to this observable object.



name

Type: naming:Name
Primitive Type: string:Basic

Overrides:naming:NamedObject:name
Units: null Encrypted: false Access: admin Category: TopLevelRegular
    Comments:
null



nameAlias

Type: naming:NameAlias
Primitive Type: string:Basic

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



ownerKey

Type: naming:Descr
Primitive Type: string:Basic

Units: null
Encrypted: false
Access: admin
Category: TopLevelRegular
    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
    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
    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
    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.






type

Type: cloud:ActionType
Primitive Type: scalar:Enum8

Overrides:cloud:ARuleAction:type
Units: null Encrypted: false Naming Property -- [NAMING RULES] Access: naming Category: TopLevelRegular
    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
haPort 3 All port traffic load balancing NO COMMENTS
DEFAULT forward(0) Forward NO COMMENTS