Class hcloud:AAction (ABSTRACT)

Class ID:15210
Class Label: Native Service Listener Action
Encrypted: false - Exportable: false - Persistent: true - Configurable: false - Subject to Quota: Disabled - Abstraction Layer: Concrete Model - APIC NX Processing: Enabled
Write Access: [NON CONFIGURABLE]
Read Access: [admin, tenant-security]
Creatable/Deletable: derived (see Container Mos for details)
Semantic Scope: None
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: hcloud:ACloudBase,
Sub Mos: hcloud:RuleAction,
Relations From: hcloud:ASelector,
Relations To: hcloud:TargetGroup,
Relations: hcloud:RsActionToTargetGroup, hcloud:RtSelectorToTagParent,


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:AAction
cloud:ActionType
          scalar:Enum8
actionType  (hcloud:AAction:actionType)
           NO COMMENTS
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: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

actionType

Type: cloud:ActionType
Primitive Type: scalar:Enum8

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



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.



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.