Class svccopy:Dest (CONCRETE)

Class ID:7462
Class Label: Copy Destination
Encrypted: false - Exportable: false - Persistent: true - Configurable: false - Subject to Quota: Disabled
Write Access: [NON CONFIGURABLE]
Read Access: [admin, nw-svc-policy]
Creatable/Deletable: yes (see Container Mos for details)
Semantic Scope: Fabric
Semantic Scope Evaluation Rule: Parent
Monitoring Policy Source: Parent
Monitoring Flags : [ IsObservable: true, HasStats: false, HasFaults: true, HasHealth: true, HasEventRules: false ]

Copy dest, represents a destination to which is a copy is sent

Naming Rules
RN FORMAT: dest-{[tepIp]}-{[bdVnid]}

    [1] PREFIX=dest- PROPERTY = tepIp


    [2] PREFIX=- PROPERTY = bdVnid




DN FORMAT: 

[0] topology/pod-{id}/node-{id}/sys/svccopy/inst/dest-{[tepIp]}-{[bdVnid]}

[1] sys/svccopy/inst/dest-{[tepIp]}-{[bdVnid]}

                


Diagram

Container Mos: svccopy:Inst (deletable:yes),
Contained Mos: vns:SvcCopyCons,
Relations From: svccopy:DestGrp,
Relations: svccopy:RtCopyDestAtt,


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] top:System The APIC uses a policy model to combine data into a health score. Health scores can be aggregated for a variety of areas such as for the infrastructure, applications, or services. The category health score is calculated using a Lp -Norm formula. The health score penalty equals 100 minus the health score. The health score penalty represents the overall health score penalties of a set of MOs that belong to a given category and are children or direc...
 
 
 
 
 ├
[V] svccopy:Entity  Holds service control plane entity information
 
 
 
 
 
 ├
[V] svccopy:Inst  Holds service instance information
 
 
 
 
 
 
 ├
[V] svccopy:Dest  Copy dest, represents a destination to which is a copy is sent
[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] top:System The APIC uses a policy model to combine data into a health score. Health scores can be aggregated for a variety of areas such as for the infrastructure, applications, or services. The category health score is calculated using a Lp -Norm formula. The health score penalty equals 100 minus the health score. The health score penalty represents the overall health score penalties of a set of MOs that belong to a given category and are children or direc...
 
 ├
[V] svccopy:Entity  Holds service control plane entity information
 
 
 ├
[V] svccopy:Inst  Holds service instance information
 
 
 
 ├
[V] svccopy:Dest  Copy dest, represents a destination to which is a copy is sent


Contained Hierarchy
[V] svccopy:Dest  Copy dest, represents a destination to which is a copy is sent
 ├
[V] fault:Counts An immutable object that provides the number of critical, major, minor, and warning faults raised on its parent object and its subtree.
 ├
[V] fault:Inst Contains detailed information of a fault. This object is attached as a child of the object on which the fault condition occurred. One instance object is created for each fault condition of the parent object. A fault instance object is identified by a fault code.
 ├
[V] health:Inst A base class for a health score instance.(Switch only)
 ├
[V] svccopy:RtCopyDestAtt  Attachment to Copy Destination
 ├
[V] vns:SvcCopyCons 


Inheritance
[V] svccopy:Dest  Copy dest, represents a destination to which is a copy is sent


Events
                


Faults
                svccopy:Dest:operStFailed


Fsms
                


Properties Summary
Defined in: svccopy:Dest
base:Encap bdVnid  (svccopy:Dest:bdVnid)
           Copy Service BD's vnid
svccopy:DestGrpId
          scalar:Uint16
id  (svccopy:Dest:id)
           DestGrp Id
reference:BinRef monPolDn  (svccopy:Dest:monPolDn)
           Monitoring policy attached to this observable object
svccopy:TruncationMtu
          scalar:Uint16
mtu  (svccopy:Dest:mtu)
           mtu truncation size for the copy packets
fabric:NodeId
          scalar:Uint16
nodeId  (svccopy:Dest:nodeId)
           Destination's NodeID
svccopy:OperSt
          scalar:Enum8
operSt  (svccopy:Dest:operSt)
           Operational state
svccopy:OperStQualDest
          scalar:Enum8
operStQual  (svccopy:Dest:operStQual)
           Operational State Qualifier
scalar:Bitmask64 svccopyCfgFailedBmp  (svccopy:Dest:svccopyCfgFailedBmp)
          
scalar:Time svccopyCfgFailedTs  (svccopy:Dest:svccopyCfgFailedTs)
          
scalar:UByte svccopyCfgState  (svccopy:Dest:svccopyCfgState)
          
address:Ip tepIp  (svccopy:Dest:tepIp)
           Copy Destination's Tunnel End Point IP Address
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: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:Modifiable
mo:TStamp
          scalar:Date
modTs  (mo:Modifiable:modTs)
           The time when this object was last modified.
Properties Detail

bdVnid

Type: base:Encap

Units: null
Encrypted: false
Naming Property -- [NAMING RULES]
Access: naming
Category: TopLevelRegular
    Comments:
Copy Service BD's vnid



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





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.



id

Type: svccopy:DestGrpId
Primitive Type: scalar:Uint16

Units: null
Encrypted: false
Access: implicit
Category: TopLevelRegular
    Comments:
DestGrp Id
Constants
defaultValue 1 --- 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





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:
Monitoring policy attached to this observable object



mtu

Type: svccopy:TruncationMtu
Primitive Type: scalar:Uint16

Units: null
Encrypted: false
Access: implicit
Category: TopLevelRegular
    Comments:
mtu truncation size for the copy packets
Constants
defaultValue 1518 --- NO COMMENTS





nodeId

Type: fabric:NodeId
Primitive Type: scalar:Uint16

Units: null
Encrypted: false
Access: implicit
Category: TopLevelRegular
    Comments:
Destination's NodeID
Constants
defaultValue 1 --- NO COMMENTS





operSt

Type: svccopy:OperSt
Primitive Type: scalar:Enum8

Units: null
Encrypted: false
Access: oper
Category: TopLevelRegular
    Comments:
Operational state
Constants
enabled 1 enabled Operational state is Enabled
disabled 2 disabled Operational state is Disabled
DEFAULT disabled(2) disabled Operational state is Disabled





operStQual

Type: svccopy:OperStQualDest
Primitive Type: scalar:Enum8

Units: null
Encrypted: false
Access: oper
Category: TopLevelRegular
    Comments:
Operational State Qualifier
Constants
no-oper-dest 0 No oper dest no oper dest
active 1 The session is up dest is up
no-hw-res 2 No hardware resource No Hardware resource
error 3 Generic error Generic error
unknown-vrf 4 Unknown vrf unknown vrf
unres-tun-ip 5 Unresolved tunnel IP unable to resolve tunnel ip
tun-down 6 Tunnel down unable to resolve tunnel down
unknown-vlan 7 Vlan of interface in copy BD is not available yet unable to resolve tunnel down
obj-error 8 objstore input error objstore input error
hw-err 9 Hardware error Hardware error
DEFAULT no-oper-dest(0) No oper dest no oper dest





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.






svccopyCfgFailedBmp

Type: scalar:Bitmask64

Units: null
Encrypted: false
Access: oper
Category: TopLevelRegular
    Comments:
Constants
svccopy:DestlcOwn_failed_flag -9223372036854775808ull --- NO COMMENTS
svccopy:DesttepIp_failed_flag 1024ull --- NO COMMENTS
svccopy:DestnodeId_failed_flag 16ull --- NO COMMENTS
svccopy:DestbdVnid_failed_flag 1ull --- NO COMMENTS
svccopy:DestmodTs_failed_flag 2305843009213693952ull --- NO COMMENTS
svccopy:Destid_failed_flag 2ull --- NO COMMENTS
svccopy:DestmonPolDn_failed_flag 4ull --- NO COMMENTS
svccopy:Destmtu_failed_flag 8ull --- NO COMMENTS
DEFAULT 0 --- NO COMMENTS





svccopyCfgFailedTs

Type: scalar:Time

Units: null
Encrypted: false
Access: oper
Category: TopLevelRegular
    Comments:



svccopyCfgState

Type: scalar:UByte

Units: null
Encrypted: false
Access: oper
Category: TopLevelRegular
    Comments:



tepIp

Type: address:Ip

Units: null
Encrypted: false
Naming Property -- [NAMING RULES]
Access: naming
Category: TopLevelRegular
    Comments:
Copy Destination's Tunnel End Point IP Address