Class hcloud:RuleAction (CONCRETE)

Class ID:15213
Class Label: Native Service Listener Rule Action
Encrypted: false - Exportable: false - Persistent: true - Configurable: false - Subject to Quota: Disabled - Abstraction Layer: Logical Model - APIC NX Processing: Enabled
Write Access: [NON CONFIGURABLE]
Read Access: [admin, tenant-connectivity-l3, tenant-ext-connectivity-l3, tenant-security]
Creatable/Deletable: yes (see Container Mos for details)
Semantic Scope: None
Semantic Scope Evaluation Rule: Parent
Monitoring Policy Source: Parent
Monitoring Flags : [ IsObservable: true, HasStats: false, HasFaults: false, HasHealth: true, HasEventRules: false ]

Action for a rule of a listener

Naming Rules
RN FORMAT: action-{actionType}

    [1] PREFIX=action- PROPERTY = actionType




DN FORMAT: 

[0] cprov-{vendor}/provacc-{[name]}/acct-{[name]}/region-{[regionName]}/context-{[name]}-addr-{[primaryCidr]}/nativeLB-{[name]}-oid-{oid}/listener-{[name]}/rule-{[name]}/action-{actionType}

[1] acct-{[name]}/region-{[regionName]}/context-{[name]}-addr-{[primaryCidr]}/nativeLB-{[name]}-oid-{oid}/listener-{[name]}/rule-{[name]}/action-{actionType}

                


Diagram

Super Mo: hcloud:AAction,
Container Mos: hcloud:ListenerRule (deletable:yes),
Relations From: hcloud:ASelector,
Relations To: hcloud:TargetGroup,
Relations: hcloud:RsActionToTargetGroup, hcloud:RtSelectorToTagParent,


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] hcloud:Prov  MOs Cloud Provider
 
 ├
[V] hcloud:ProvAccount  Cloud Provider Account
 
 
 ├
[V] hcloud:Account 
 
 
 
 ├
[V] hcloud:Region 
 
 
 
 
 ├
[V] hcloud:Ctx 
 
 
 
 
 
 ├
[V] hcloud:NativeLB 
 
 
 
 
 
 
 ├
[V] hcloud:Listener 
 
 
 
 
 
 
 
 ├
[V] hcloud:ListenerRule 
 
 
 
 
 
 
 
 
 ├
[V] hcloud:RuleAction  Action for a rule of a listener
[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] hcloud:Account 
 
 ├
[V] hcloud:Region 
 
 
 ├
[V] hcloud:Ctx 
 
 
 
 ├
[V] hcloud:NativeLB 
 
 
 
 
 ├
[V] hcloud:Listener 
 
 
 
 
 
 ├
[V] hcloud:ListenerRule 
 
 
 
 
 
 
 ├
[V] hcloud:RuleAction  Action for a rule of a listener


Contained Hierarchy
[V] hcloud:RuleAction  Action for a rule of a listener
 ├
[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] hcloud:RsActionToTargetGroup 
 
 ├
[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] hcloud:RtSelectorToTagParent 
 ├
[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] hcloud:ACloudBase 
 
 
 ├
[V] hcloud:AAction 
 
 
 
 ├
[V] hcloud:RuleAction  Action for a rule of a listener


Events
                


Faults
                


Fsms
                


Properties Summary
Defined in: hcloud:RuleAction
cloud:ActionType
          scalar:Enum8
actionType  (hcloud:RuleAction:actionType)
           Overrides:hcloud:AAction:actionType
           NO COMMENTS
Defined in: hcloud:AAction
cloud:FixedResponseContentType
          scalar:Enum8
contentType  (hcloud:AAction:contentType)
           NO COMMENTS
string:Basic host  (hcloud:AAction:host)
           The hostname or IP for export destination. Call Home sends email messages to either the IP address or hostname, and the associated port number.
string:Basic message  (hcloud:AAction:message)
           The contents of the informational banner to be displayed before user login authentication.
string:Basic path  (hcloud:AAction:path)
           Ignore, removed
string:Basic port  (hcloud:AAction:port)
           The service port number for the LDAP service.
cloud:RedirectProtocol
          scalar:Enum8
protocol  (hcloud:AAction:protocol)
           The transfer protocol to be used for data export.
string:Basic query  (hcloud:AAction:query)
           NO COMMENTS
cloud:RedirectCode
          scalar:Enum16
redirectCode  (hcloud:AAction:redirectCode)
           NO COMMENTS
string:Basic responseCode  (hcloud:AAction:responseCode)
           NO COMMENTS
Defined in: hcloud:ACloudBase
naming:Name
          string:Basic
name  (hcloud:ACloudBase:name)
           Overrides:pol:Obj:name | naming:NamedObject:name
           The name of the object.
naming:NameAlias
          string:Basic
nameAlias  (hcloud:ACloudBase:nameAlias)
           Overrides:naming:NamedObject:nameAlias
           NO COMMENTS
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.
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.
Properties Detail

actionType

Type: cloud:ActionType
Primitive Type: scalar:Enum8

Overrides:hcloud:AAction:actionType
Units: null Encrypted: false Naming Property -- [NAMING RULES] Access: naming Category: TopLevelRegular
    Comments:
NO COMMENTS
Constants
forward 0 Forward NO COMMENTS
redirect 1 Redirect NO COMMENTS
fixedResponse 2 Return fixed response NO COMMENTS
DEFAULT forward(0) Forward 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





contentType

Type: cloud:FixedResponseContentType
Primitive Type: scalar:Enum8

Units: null
Encrypted: false
Access: implicit
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





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.



host

Type: string:Basic

Units: null
Encrypted: false
Access: implicit
Category: TopLevelRegular
    Comments:
The hostname or IP for export destination. Call Home sends email messages to either the IP address or hostname, and the associated port number.



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





message

Type: string:Basic

Units: null
Encrypted: false
Access: implicit
Category: TopLevelRegular
    Comments:
The contents of the informational banner to be displayed before user login authentication.



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





name

Type: naming:Name
Primitive Type: string:Basic

Overrides:pol:Obj:name  |  naming:NamedObject:name
Units: null Encrypted: false Access: implicit Category: TopLevelRegular
    Comments:
The name of the object.



nameAlias

Type: naming:NameAlias
Primitive Type: string:Basic

Overrides:naming:NamedObject:nameAlias
Units: null Encrypted: false Access: implicit Category: TopLevelRegular
    Comments:
NO COMMENTS



path

Type: string:Basic

Units: null
Encrypted: false
Access: implicit
Category: TopLevelRegular
    Comments:
Ignore, removed



port

Type: string:Basic

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



protocol

Type: cloud:RedirectProtocol
Primitive Type: scalar:Enum8

Units: null
Encrypted: false
Access: implicit
Category: TopLevelRegular
    Comments:
The transfer protocol to be used for data export.
Constants
inherit 0 inherit NO COMMENTS
http 1 HTTP NO COMMENTS
https 2 HTTPS NO COMMENTS
DEFAULT inherit(0) inherit NO COMMENTS





query

Type: string:Basic

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



redirectCode

Type: cloud:RedirectCode
Primitive Type: scalar:Enum16

Units: null
Encrypted: false
Access: implicit
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





responseCode

Type: string:Basic

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