Properties Summary |
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.
|
adminSt
Type: action:AdminSt
Primitive Type: scalar:Enum8
Units: null
Encrypted: false
Access: admin
Category: TopLevelRegular
Property Validators:
Comments:
-
Administrative state of the monitoring policy
| |
Constants |
unknown |
0 |
unknown |
NO COMMENTS
|
start |
1 |
Start |
NO COMMENTS
|
stop |
2 |
Stop |
NO COMMENTS
|
suspend |
3 |
suspend |
NO COMMENTS
|
prepare |
4 |
prepare |
NO COMMENTS
|
DEFAULT |
stop(2) |
Stop |
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.
dstIp
Type: address:Ip
Units: null
Encrypted: false
Access: create
Category: TopLevelRegular
Property Validators:
Comments:
-
The destination IP address.
dstPortEnd
Type: traceroute:PortEnd
Primitive Type: scalar:Uint16
Units: null
Encrypted: false
Access: admin
Category: TopLevelRegular
Property Validators:
Range: min: 0 max: 65535
Comments:
-
Destination Port range end value
| |
Constants |
defaultValue |
65535 |
--- |
NO COMMENTS
|
|
dstPortStart
Type: traceroute:PortStart
Primitive Type: scalar:Uint16
Units: null
Encrypted: false
Access: admin
Category: TopLevelRegular
Property Validators:
Range: min: 0 max: 65535
Comments:
-
Destination Port range start value
| |
Constants |
defaultValue |
0 |
--- |
NO COMMENTS
|
|
freq
Type: action:Freq
Primitive Type: scalar:Time
Units: null
Encrypted: false
Access: implicit
Category: TopLevelRegular
Comments:
-
Frequency at which tasks are executed
| |
Constants |
one-shot |
0ull |
One shot |
Exectue only once
|
DEFAULT |
0 |
--- |
Frequency of the task
|
|
gwMac
Type: address:MAC
Units: null
Encrypted: false
Access: admin
Category: TopLevelRegular
Property Validators:
Comments:
-
Gateway MAC
If specified, this value will be used as the
destination MAC for all the traceroute policies (for all
sources/destinations). This is applicable when there is a
firewall between the source and destination endpoint
If not specific, destination MAC will
either be the destimation endpoint MAC, if the source and
destination are in the same BD and Subnet, BD SVI IF MAC will
be used.
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
|
|
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:
-
The monitoring policy attached to this observable object.
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 name of the 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.
payloadSz
Type: oam:PayloadSz
Primitive Type: scalar:Uint16
Units: null
Encrypted: false
Access: admin
Category: TopLevelRegular
Property Validators:
Range: min: 20 max: 8904
Comments:
-
Probe packet size
| |
Constants |
defaultValue |
56 |
--- |
NO COMMENTS
|
|
prot
Type: traceroute:ProtT
Primitive Type: scalar:Enum8
Units: null
Encrypted: false
Access: admin
Category: TopLevelRegular
Property Validators:
Comments:
-
The IP protocol.
| |
Constants |
icmp |
1 |
icmp |
ICMP Protocol
|
tcp |
6 |
tcp |
TCP Protocol
|
udp |
17 |
udp |
UDP Protocol
|
DEFAULT |
udp(17) |
udp |
UDP Protocol
|
|
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.
srcPortEnd
Type: traceroute:PortEnd
Primitive Type: scalar:Uint16
Units: null
Encrypted: false
Access: admin
Category: TopLevelRegular
Property Validators:
Range: min: 0 max: 65535
Comments:
-
Source Port range end value
| |
Constants |
defaultValue |
65535 |
--- |
NO COMMENTS
|
|
srcPortStart
Type: traceroute:PortStart
Primitive Type: scalar:Uint16
Units: null
Encrypted: false
Access: admin
Category: TopLevelRegular
Property Validators:
Range: min: 0 max: 65535
Comments:
-
Source Port range start value
| |
Constants |
defaultValue |
0 |
--- |
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.
|
|
tenantName
Type: naming:Name
Primitive Type: string:Basic
Units: null
Encrypted: false
Access: implicit
Category: TopLevelRegular
Comments:
-
The tenant name.
triggerTs
Type: scalar:Date
Units: null
Encrypted: false
Access: implicit
Category: TopLevelRegular
Comments:
-
Trigger time for traceroute policy
uid
Type: scalar:Uint16
Units: null
Encrypted: false
Access: implicit
Category: TopLevelRegular
Comments:
-
A unique identifier for this object.