Cisco System Model: Classaaa:Banner

Overview

Diagram

Inheritance

Events

Faults

FSMs

Properties Summary

Properties Detail

Class aaa:Banner (ABSTRACT)

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

An abstract class that contains login banners and cannot be instantiated.

Naming Rules
DN FORMAT: [1] uni/userext/

Diagram
Super Mo: aaa:Definition, Sub Mos: aaa:PreLoginBanner, Container Mos: aaa:UserEp (deletable:yes),

Inheritance

naming:NamedObject An abstract base class for an object that contains a name.

├

pol:Obj Represents a generic policy object.

├

pol:Def Represents self-contained policy document.

├

aaa:Definition The AAA policy definition. This is an abstract class and cannot be instantiated.

├

aaa:Banner An abstract class that contains login banners and cannot be instantiated.

├

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

Events

Faults

Fsms

Properties Summary

Defined in: aaa:Banner
aaa:BannerMsg string:CharBuffer	guiMessage (aaa:Banner:guiMessage) The login banner messsage to be displayed in the GUI.
aaa:BannerMsg string:CharBuffer	guiTextMessage (aaa:Banner:guiTextMessage) NO COMMENTS
aaa:BannerMsg string:CharBuffer	message (aaa:Banner:message) A message displayed in the banner.
aaa:BannerMsg string:CharBuffer	switchMessage (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: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

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.

guiMessage

Type: aaa:BannerMsg
Primitive Type: string:CharBuffer

Units: null
Encrypted: false
Access: admin
Category: TopLevelRegular
Property Validators:

Comments:

The login banner messsage to be displayed in the GUI.

guiTextMessage

Type: aaa:BannerMsg
Primitive Type: string:CharBuffer

Units: null
Encrypted: false
Access: admin
Category: TopLevelRegular
Property Validators:

Comments:

NO COMMENTS

message

Type: aaa:BannerMsg
Primitive Type: string:CharBuffer

Units: null
Encrypted: false
Access: admin
Category: TopLevelRegular
Property Validators:

Comments:

A message displayed in the banner.

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.

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

Units: null
Encrypted: false
Access: admin
Category: TopLevelRegular
Property Validators:

Comments:

NO COMMENTS

Overview

Diagram

Inheritance

Events

Faults

FSMs

Properties Summary

Properties Detail