Class aaa:PreLoginBanner (CONCRETE)

Class ID:1494
Class Label: Pre Login Banner
Encrypted: false - Exportable: true - Persistent: true - Configurable: true - Subject to Quota: Disabled - Abstraction Layer: Ambiguous Placement in the Model - APIC NX Processing: Disabled
Write Access: [aaa, admin]
Read Access: [aaa, admin]
Creatable/Deletable: yes (see Container Mos for details)
Semantic Scope: Fabric
Semantic Scope Evaluation Rule: Parent
Monitoring Policy Source: Parent
Monitoring Flags : [ IsObservable: false, HasStats: false, HasFaults: false, HasHealth: false, HasEventRules: false ]

A GUI banner is the informational banner to be displayed before user login authentication.

Naming Rules
RN FORMAT: preloginbanner

    [1] PREFIX=preloginbanner


DN FORMAT: 

[1] uni/userext/preloginbanner

                


Diagram

Super Mo: aaa:Banner,
Container Mos: aaa:UserEp (deletable:yes),
Contained Mos: aaa:RbacAnnotation, tag:Annotation, tag:Tag,
Relations From: aaa:SecRelnHolder,
Relations: aaa:RtPreLoginBanner,


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] aaa:UserEp A user endpoint is a local user. A user is assigned a role determines the user's privileges, and belongs to a security domain, which determines the user's scope of control
 
 
 
 
 
 
 
 ├
[V] aaa:PreLoginBanner A GUI banner is the informational banner to be displayed before user login authentication.
[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] aaa:UserEp A user endpoint is a local user. A user is assigned a role determines the user's privileges, and belongs to a security domain, which determines the user's scope of control
 
 
 ├
[V] aaa:PreLoginBanner A GUI banner is the informational banner to be displayed before user login authentication.


Contained Hierarchy
[V] aaa:PreLoginBanner A GUI banner is the informational banner to be displayed before user login authentication.
 ├
[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] aaa:RtPreLoginBanner A target relation to the informational banner displayed before user login authentication.
 ├
[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] tag:Annotation 
 ├
[V] tag:Tag 


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] aaa:Definition The AAA policy definition. This is an abstract class and cannot be instantiated.
 
 
 
 ├
[V] aaa:Banner An abstract class that contains login banners and cannot be instantiated.
 
 
 
 
 ├
[V] aaa:PreLoginBanner A GUI banner is the informational banner to be displayed before user login authentication.


Events
                aaa:PreLoginBanner:creation__aaa_PreLoginBanner
aaa:PreLoginBanner:modification__aaa_PreLoginBanner
aaa:PreLoginBanner:deletion__aaa_PreLoginBanner


Faults
                


Fsms
                


Properties Summary
Defined in: aaa:PreLoginBanner
mo:Annotation
          string:Basic
annotation  (aaa:PreLoginBanner:annotation)
           NO COMMENTS
aaa:BannerMsg
          string:CharBuffer
bannerMessage  (aaa:PreLoginBanner:bannerMessage)
           Overrides:aaa:Banner:bannerMessage
           NO COMMENTS
condition:Severity
          scalar:Enum8
bannerMessageSeverity  (aaa:PreLoginBanner:bannerMessageSeverity)
           Overrides:aaa:Banner:bannerMessageSeverity
           NO COMMENTS
mo:ExtMngdByType
          scalar:Bitmask32
extMngdBy  (aaa:PreLoginBanner:extMngdBy)
           NO COMMENTS
aaa:BannerMsg
          string:CharBuffer
guiMessage  (aaa:PreLoginBanner:guiMessage)
           Overrides:aaa:Banner:guiMessage
           The contents of the GUI informational banner to be displayed before user login authentication. The GUI banner is a URL. Note that the URL site owner must allow the site to be placed in an iFrame to display the informational banner. If the owner of the site sets the X-FRAME-OPTION to DENY or SAMEORIGIN, the site the URL points to will not appear.
aaa:BannerMsg
          string:CharBuffer
guiTextMessage  (aaa:PreLoginBanner:guiTextMessage)
           Overrides:aaa:Banner:guiTextMessage
           NO COMMENTS
aaa:BannerMsg
          string:CharBuffer
message  (aaa:PreLoginBanner:message)
           Overrides:aaa:Banner:message
           The contents of the CLI informational banner to be displayed before user login authentication. The CLI banner is a text based string printed as-is to the console.
scalar:Bool showBannerMessage  (aaa:PreLoginBanner:showBannerMessage)
           Overrides:aaa:Banner:showBannerMessage
           NO COMMENTS
aaa:BannerMsg
          string:CharBuffer
switchMessage  (aaa:PreLoginBanner:switchMessage)
           Overrides:aaa:Banner:switchMessage
           NO COMMENTS
Defined in: aaa:Definition
naming:Name
          string:Basic
name  (aaa:Definition:name)
           Overrides:pol:Obj:name | naming:NamedObject:name
           The name of the AAA definition object.
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: naming:NamedObject
naming:NameAlias
          string:Basic
nameAlias  (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.
Defined in: mo:Ownable
scalar:Uint16 uid  (mo:Ownable:uid)
           A unique identifier for this object.
Properties Detail

annotation

Type: mo:Annotation
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:
NO COMMENTS



bannerMessage

Type: aaa:BannerMsg
Primitive Type: string:CharBuffer

Overrides:aaa:Banner:bannerMessage
Units: null Encrypted: false Access: admin Category: TopLevelRegular Property Validators:
    Comments:
NO COMMENTS
Constants
defaultValue "" --- NO COMMENTS





bannerMessageSeverity

Type: condition:Severity
Primitive Type: scalar:Enum8

Overrides:aaa:Banner:bannerMessageSeverity
Units: null Encrypted: false Access: admin Category: TopLevelRegular Property Validators:
    Comments:
NO COMMENTS
Constants
cleared 0 cleared The Cleared severity level indicates the clearing of one or more previously reported alarms. This alarm clears all alarms for this managed object that have the same Alarm type, Probable cause and Specific problems (if given). Multiple associated notifications may be cleared by using the Correlated notifications parameter (defined below).
info 1 info NO COMMENTS
warning 2 warning The Warning severity level indicates the detection of a potential or impending service affecting fault, before any significant effects have been felt. Action should be taken to further diagnose (if necessary) and correct the problem in order to prevent it from becoming a more serious service affecting fault.
minor 3 minor The Minor severity level indicates the existence of a non-service affecting fault condition and that corrective action should be taken in order to prevent a more serious (for example, service affecting) fault. Such a severity can be reported, for example, when the detected alarm condition is not currently degrading the capacity of the managed object.
major 4 major The Major severity level indicates that a service affecting condition has developed and an urgent corrective action is required. Such a severity can be reported, for example, when there is a severe degradation in the capability of the managed object and its full capability must be restored.
critical 5 critical The Critical severity level indicates that a service affecting condition has occurred and an immediate corrective action is required. Such a severity can be reported, for example, when a managed object becomes totally out of service and its capability must be restored.
DEFAULT info(1) info 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.



extMngdBy

Type: mo:ExtMngdByType
Primitive Type: scalar:Bitmask32

Units: null
Encrypted: false
Access: implicit
Category: TopLevelRegular
    Comments:
NO COMMENTS
Constants
undefined 0u undefined NO COMMENTS
msc 1u msc NO COMMENTS
DEFAULT undefined(0u) undefined NO COMMENTS





guiMessage

Type: aaa:BannerMsg
Primitive Type: string:CharBuffer

Overrides:aaa:Banner:guiMessage
Units: null Encrypted: false Access: admin Category: TopLevelRegular Property Validators:
    Comments:
The contents of the GUI informational banner to be displayed before user login authentication. The GUI banner is a URL. Note that the URL site owner must allow the site to be placed in an iFrame to display the informational banner. If the owner of the site sets the X-FRAME-OPTION to DENY or SAMEORIGIN, the site the URL points to will not appear.
Constants
defaultValue "" --- NO COMMENTS





guiTextMessage

Type: aaa:BannerMsg
Primitive Type: string:CharBuffer

Overrides:aaa:Banner:guiTextMessage
Units: null Encrypted: false Access: admin Category: TopLevelRegular Property Validators:
    Comments:
NO COMMENTS
Constants
defaultValue "" --- 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





message

Type: aaa:BannerMsg
Primitive Type: string:CharBuffer

Overrides:aaa:Banner:message
Units: null Encrypted: false Access: admin Category: TopLevelRegular Property Validators:
    Comments:
The contents of the CLI informational banner to be displayed before user login authentication. The CLI banner is a text based string printed as-is to the console.
Constants
defaultValue "Application Policy Infrastructure Controller" --- 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





name

Type: naming:Name
Primitive Type: string:Basic

Overrides:pol:Obj:name  |  naming:NamedObject:name
Units: null Encrypted: false Access: create Category: TopLevelRegular Property Validators: Range: min: "0" max: "64" Allowed Chars: Regex: [a-zA-Z0-9_.:-]+
    Comments:
The name of the AAA definition 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



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.



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.



showBannerMessage

Type: scalar:Bool

Overrides:aaa:Banner:showBannerMessage
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





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.






switchMessage

Type: aaa:BannerMsg
Primitive Type: string:CharBuffer

Overrides:aaa:Banner:switchMessage
Units: null Encrypted: false Access: admin Category: TopLevelRegular Property Validators:
    Comments:
NO COMMENTS
Constants
defaultValue "" --- NO COMMENTS





uid

Type: scalar:Uint16

Units: null
Encrypted: false
Access: implicit
Category: TopLevelRegular
    Comments:
A unique identifier for this object.