Properties Summary |
Defined in: callhome:Dest |
mon:AdminState
scalar:Enum8
|
adminState (callhome:Dest:adminState)
Indicates if the destination policy is enabled or disabled. If enabled, the system uses the destination policy when an error matching the associated cause is encountered. Otherwise, the system ignores the policy even if a matching error occurs. By default, all policies are enabled.
|
callhome:Email
string:Basic
|
email (callhome:Dest:email)
The Call Home destination email address. This is the email address of the message recipient. The destination email address is in the destination profile.
|
callhome:MsgFormat
scalar:Enum8
|
format (callhome:Dest:format)
The Call Home destination message format.
|
scalar:Uint32
|
maxSize (callhome:Dest:maxSize)
The maximum size (in bytes) for a Call Home message to a specific destination.
|
reference:BinRef
|
monPolDn (callhome:Dest:monPolDn)
|
naming:Name
string:Basic
|
name (callhome:Dest:name)
Overrides:pol:Obj:name | naming:NamedObject:name
The user-defined name for the Call Home destination.
|
callhome:Urgency
scalar:Enum8
|
urgency (callhome:Dest:urgency)
The severity level for Call Home destinations. The Call Home destination is an object that also contains the recipient's email address and a format selection (.xml, .aml, or short-test).
|
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.
|
adminState
Type: mon:AdminState
Primitive Type: scalar:Enum8
Units: null
Encrypted: false
Access: admin
Category: TopLevelRegular
Property Validators:
Comments:
-
Indicates if the destination policy is enabled or disabled. If enabled, the system uses the destination policy when an error matching the associated cause is encountered. Otherwise, the system ignores the policy even if a matching error occurs. By default, all policies are enabled.
| |
Constants |
enabled |
1 |
enabled |
NO COMMENTS
|
disabled |
2 |
disabled |
NO COMMENTS
|
DEFAULT |
enabled(1) |
enabled |
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 the description of a policy component.
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.
email
Type: callhome:Email
Primitive Type: string:Basic
Units: null
Encrypted: false
Access: admin
Category: TopLevelRegular
Property Validators:
Regex: ˆ$|ˆ(?!.{64,})[a-zA-Z0-9._%+-]+@[a-zA-Z0-9.-]+$
Comments:
-
The Call Home destination email address. This is the email address of the message recipient. The destination email address is in the destination profile.
format
Type: callhome:MsgFormat
Primitive Type: scalar:Enum8
Units: null
Encrypted: false
Access: admin
Category: TopLevelRegular
Property Validators:
Comments:
-
The Call Home destination message format.
| |
Constants |
xml |
1 |
xml |
NO COMMENTS
|
aml |
2 |
aml |
NO COMMENTS
|
short-txt |
3 |
short-txt |
NO COMMENTS
|
DEFAULT |
xml(1) |
xml |
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
|
|
maxSize
Type: scalar:Uint32
Units: null
Encrypted: false
Access: admin
Category: TopLevelRegular
Property Validators:
Range: min: (long)0l max: (long)5000000l
Comments:
-
The maximum size (in bytes) for a Call Home message to a specific destination.
| |
Constants |
defaultValue |
1000000u |
--- |
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:
-
name
Type: naming:Name
Primitive Type: string:Basic
Overrides:pol:Obj:name | naming:NamedObject:name
Units: null
Encrypted: false
Naming Property -- [NAMING RULES]
Access: naming
Category: TopLevelRegular
Property Validators:
Range: min: "1" max: "64"
Allowed Chars:
Regex: [a-zA-Z0-9_.:-]+
Comments:
-
The user-defined name for the Call Home destination.
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
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.
|
|
uid
Type: scalar:Uint16
Units: null
Encrypted: false
Access: implicit
Category: TopLevelRegular
Comments:
-
A unique identifier for this object.
urgency
Type: callhome:Urgency
Primitive Type: scalar:Enum8
Units: null
Encrypted: false
Access: admin
Category: TopLevelRegular
Property Validators:
Comments:
-
The severity level for Call Home destinations. The Call Home destination is an object that also contains the recipient's email address and a format selection (.xml, .aml, or short-test).
| |
Constants |
emergency |
0 |
emergencies |
NO COMMENTS
|
alert |
1 |
alerts |
NO COMMENTS
|
critical |
2 |
critical |
NO COMMENTS
|
error |
3 |
errors |
NO COMMENTS
|
warning |
4 |
warnings |
NO COMMENTS
|
notice |
5 |
notifications |
NO COMMENTS
|
info |
6 |
information |
NO COMMENTS
|
debug |
7 |
debugging |
NO COMMENTS
|
DEFAULT |
alert(1) |
alerts |
NO COMMENTS
|
|