Overview  Containers  Contained  Inheritance  Events  Faults  FSMs  Properties Summary  Properties Detail  Naming 

Class fabric:LanPinTarget (CONCRETE)

Class ID:121
Encrypted: false - Exportable: true - Persistent: true
Privileges: [admin, ext-lan-config, ext-lan-policy]
SNMP OID: .1.3.6.1.4.1.9.9.719.1.45.76

A target Ethernet interface within an Ethernet PIN group. The target may be a single port or a port channel. This is configured by the API user.

Naming Rules 
RN FORMAT: target-[fabricId]

    [1] PREFIX=target- PROPERTY = fabricId




DN FORMAT: 

[0] fabric/lan/lan-pin-group-[name]/target-[fabricId]


Containers Hierarchies
top:Root This class represents the root element in the object hierarchy. All managed objects in the system are descendants of the Root element.
 ├
 		fabric:Ep The root container of all fabric configuration objects.
 
 		 ├
 		fabric:LanCloud A container for logical Ethernet configuration Objects that span across the Fabric Interconnects. The contained configuration objects specify the logical Ethernet configuration, including fabric A and B, VLANs, pin groups, flow control policy, QoS policy, threshold policy, and port profiles.
 
 		 
 		 ├
 		fabric:LanPinGroup An Ethernet PIN Group, which specifies how to distribute the traffic from the servers on the Ethernet uplink interfaces. UCS uses LAN pin groups to pin Ethernet traffic from a vNIC on a server to an uplink Ethernet port or port channel on the fabric interconnect. You can use this pinning to manage the distribution of traffic from the servers. To configure pinning for a server, you must include the LAN pin group in a vNIC poli...
 
 		 
 		 
 		 ├
 		fabric:LanPinTarget


Contained Hierarchy
fabric:LanPinTarget
 ├
 		fault:Inst An abnormal condition or defect at the component, equipment, or sub-system level which may lead to a failure, as defined in ISO/CD 10303-226.
Inheritance
fabric:PinTarget An abstract representation of a pinning target. Concrete subclasses defines specific pinning targets, such as Ethernet pinning target and FC pinning target.
 ├
 		fabric:LanPinTarget
Events


Faults 
                fabric:PinTarget:down


Fsms


Properties Summary
Defined in: fabric:LanPinTarget
fabric:Id
          scalar:Enum8 		fabricId  (fabric:LanPinTarget:fabricId)
           Overrides:fabric:PinTarget:fabricId
           NO COMMENTS
Defined in: fabric:PinTarget
equipment:PortId
          scalar:Uint32 		aggrPortId  (fabric:PinTarget:aggrPortId)
           NO COMMENTS
reference:Object epDn  (fabric:PinTarget:epDn)
           reference to fabric ep s.a. fabric exposed port channel or regular border port.
scalar:Uint32 portId  (fabric:PinTarget:portId)
           NO COMMENTS
equipment:SlotId
          scalar:Uint32 		slotId  (fabric:PinTarget:slotId)
           adding these properties to support the CLI for breakout port as Target
fabric:TargetStatus
          scalar:Enum8 		targetStatus  (fabric:PinTarget:targetStatus)
           targetStatus indicates whether the target is valid or not.
Defined in: mo:TopProps
mo:ModificationChildAction
          scalar:Bitmask32 		childAction  (mo:TopProps:childAction)
          
reference:Object dn  (mo:TopProps:dn)
           The Distinguished Name (dn) unambiguously identifies an object in the system.
The dn provides a fully qualified path from the top of the object tree, all the way to the object. It is built as a sequence of relative names separated by the "/" character.
For example:
< ... dn = "sys/chassis-5/blade-2/adaptor-1" />
reference:RN rn  (mo:TopProps:rn)
           The Relative Name (rn) uniquely identifies an object within a given context.
Note that a dn is comprised of a sequence of relative names. For example, the context "sys/chassis-1/blade-1/adaptor-1/host-eth-2" can be thought of as the following expression:
dn = <root object>/{rn}/{rn}/{rn}/{rn}/{rn}.
The rn can then be used to identify the object (for instance, "adaptor-1") within the context:
<... rn ="../" />
mo:InstSaclType
          scalar:Bitmask8 		sacl  (mo:TopProps:sacl)
           The system acl property for each Managed Object. br/> This property is a 8 bit mask and supports the following values :-
a: del
b: mod
c: addchild
d: cascade

By default all Managed Objects have the following permissions
a: del
b: mod
c: addchild
This property is persisted in the db. If this property has a value none
it means, the user has read only permissions on this object.
mo:ModificationStatus
          scalar:Bitmask32 		status  (mo:TopProps:status)
           This property controls the life cycle of a managed object
Properties Detail

aggrPortId

Type: equipment:PortId
Primitive Type: scalar:Uint32
Units: null
Encrypted: false
Access: admin
Category: TopLevelRegular
Property Validators:
    Range:  min: (long)0l  max: (long)40l

Comments:
NO COMMENTS

childAction

Type: mo:ModificationChildAction
Primitive Type: scalar:Bitmask32
Units: null
Encrypted: false
Access: implicit
Category: TopLevelChildAction
Property Validators:

Comments:
Constants
deleteAll 16384u NO COMMENTS
ignore 4096u NO COMMENTS
deleteNonPresent 8192u NO COMMENTS
DEFAULT 0 This type is used to

dn

Type: reference:Object
Units: null
Encrypted: false
Access: implicit
Category: TopLevelDn
Property Validators:

Comments:
The Distinguished Name (dn) unambiguously identifies an object in the system.
The dn provides a fully qualified path from the top of the object tree, all the way to the object. It is built as a sequence of relative names separated by the "/" character.
For example:
< ... dn = "sys/chassis-5/blade-2/adaptor-1" />

epDn

Type: reference:Object
Refers: sw:BorderEp
Units: null
Encrypted: false
Access: admin
Category: TopLevelRegular
Property Validators:

Comments:
reference to fabric ep s.a. fabric exposed port channel or regular border port.

fabricId

Type: fabric:Id
Primitive Type: scalar:Enum8
Overrides:fabric:PinTarget:fabricId
Units: null
Encrypted: false
Naming Property -- [NAMING RULES]
Access: naming
Category: TopLevelRegular
Property Validators:

Comments:
NO COMMENTS
Constants
NONE 0 NO COMMENTS
A 1 NO COMMENTS
B 2 NO COMMENTS
dual 3 NO COMMENTS
DEFAULT dual(3) NO COMMENTS

portId

Type: scalar:Uint32
Units: null
Encrypted: false
Access: admin
Category: TopLevelRegular
Property Validators:
    Range:  min: (long)0l  max: (long)4l

Comments:
NO COMMENTS

rn

Type: reference:RN
Units: null
Encrypted: false
Access: implicit
Category: TopLevelRn
Property Validators:

Comments:
The Relative Name (rn) uniquely identifies an object within a given context.
Note that a dn is comprised of a sequence of relative names. For example, the context "sys/chassis-1/blade-1/adaptor-1/host-eth-2" can be thought of as the following expression:
dn = <root object>/{rn}/{rn}/{rn}/{rn}/{rn}.
The rn can then be used to identify the object (for instance, "adaptor-1") within the context:
<... rn ="../" />

sacl

Type: mo:InstSaclType
Primitive Type: scalar:Bitmask8
Units: null
Encrypted: false
Access: implicit
Category: TopLevelSacl
Property Validators:

Comments:
The system acl property for each Managed Object. br/> This property is a 8 bit mask and supports the following values :-
a: del
b: mod
c: addchild
d: cascade

By default all Managed Objects have the following permissions
a: del
b: mod
c: addchild
This property is persisted in the db. If this property has a value none
it means, the user has read only permissions on this object.
Constants
none 0 NO COMMENTS
del 1 NO COMMENTS
mod 2 NO COMMENTS
addchild 4 NO COMMENTS
cascade 8 NO COMMENTS
DEFAULT 0 NO COMMENTS

slotId

Type: equipment:SlotId
Primitive Type: scalar:Uint32
Units: null
Encrypted: false
Access: admin
Category: TopLevelRegular
Property Validators:
    Range:  min: (long)0l  max: (long)2l

Comments:
adding these properties to support the CLI for breakout port as Target

status

Type: mo:ModificationStatus
Primitive Type: scalar:Bitmask32
Units: null
Encrypted: false
Access: implicit
Category: TopLevelStatus
Property Validators:

Comments:
This property controls the life cycle of a managed object
Constants
removed 16u In a setter method: specifies that an object should be removed.
In the return value of a setter method: indicates that an object has been removed.
created 2u 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 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 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.

targetStatus

Type: fabric:TargetStatus
Primitive Type: scalar:Enum8
Units: null
Encrypted: false
Access: implicit
Category: TopLevelRegular
Property Validators:

Comments:
targetStatus indicates whether the target is valid or not.
Constants
valid 0 NO COMMENTS
invalid 1 NO COMMENTS
DEFAULT invalid(1) NO COMMENTS
Overview  Containers  Contained  Inheritance  Events  Faults  FSMs  Properties Summary  Properties Detail  Naming