Class vnic:SanConnTempl (CONCRETE)

Class ID:160
Encrypted: false - Exportable: true - Persistent: true
Privileges: [admin, ls-storage, ls-storage-policy]
SNMP OID: .1.3.6.1.4.1.9.9.719.1.133.63

A vHBA template is a policy that defines how a vHBA on a server connects to the SAN.

You can bind a vHBA associated with a service profile to a vHBA template. When you bind the vHBA to a vHBA template, Cisco UCS Manager configures the vHBA with the values defined in the vHBA template. If the existing vHBA configuration does not match the vHBA template, Cisco UCS Manager reconfigures the vHBA. You can only change the configuration of a bound vHBA through the associated vHBA template. You cannot bind a vHBA to a vHBA template if the service profile that includes the vHBA is already bound to a service profile template.


Naming Rules
RN FORMAT: san-conn-templ-[name]

    [1] PREFIX=san-conn-templ- PROPERTY = name




DN FORMAT: 

[0] org-[name]/san-conn-templ-[name]

                



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.
 ├
org:Org
 
 ├
vnic:SanConnTempl


Contained Hierarchy
vnic:SanConnTempl
 ├
fabric:ANetGroupRef
 ├
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.
 ├
vnic:FcIf
 
 ├
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
naming:NamedObject
 ├
policy:Object
 
 ├
policy:Definition
 
 
 ├
vnic:Templ
 
 
 
 ├
vnic:SanConnTempl

Events
                



Faults
                



Fsms
                



Properties Summary
Defined in: vnic:SanConnTempl
pool:Name
          string:Basic
identPoolName  (vnic:SanConnTempl:identPoolName)
           Overrides:vnic:Templ:identPoolName
           NO COMMENTS
storage:MaxDataFieldSize
          scalar:Uint32
maxDataFieldSize  (vnic:SanConnTempl:maxDataFieldSize)
           NO COMMENTS
naming:Name
          string:Basic
name  (vnic:SanConnTempl:name)
           Overrides:policy:Object:name | naming:NamedObject:name
           NO COMMENTS
naming:Name
          string:Basic
nwCtrlPolicyName  (vnic:SanConnTempl:nwCtrlPolicyName)
           Overrides:vnic:Templ:nwCtrlPolicyName
           NO COMMENTS
reference:Object operIdentPoolName  (vnic:SanConnTempl:operIdentPoolName)
           NO COMMENTS
reference:Object operPeerRedundancyTemplName  (vnic:SanConnTempl:operPeerRedundancyTemplName)
           NO COMMENTS
reference:Object operQosPolicyName  (vnic:SanConnTempl:operQosPolicyName)
           NO COMMENTS
naming:Name
          string:Basic
peerRedundancyTemplName  (vnic:SanConnTempl:peerRedundancyTemplName)
           NO COMMENTS
naming:Name
          string:Basic
qosPolicyName  (vnic:SanConnTempl:qosPolicyName)
           Overrides:vnic:Templ:qosPolicyName
           NO COMMENTS
vnic:RedundancyPairType
          scalar:Enum8
redundancyPairType  (vnic:SanConnTempl:redundancyPairType)
           Overrides:vnic:Templ:redundancyPairType
           NO COMMENTS
vnic:TemplateTarget
          scalar:Bitmask8
target  (vnic:SanConnTempl:target)
           Overrides:vnic:Templ:target
           NO COMMENTS
vnic:TemplateType
          scalar:Enum8
templType  (vnic:SanConnTempl:templType)
           Overrides:vnic:Templ:templType
           NO COMMENTS
Defined in: vnic:Templ
reference:Object operStatsPolicyName  (vnic:Templ:operStatsPolicyName)
           NO COMMENTS
naming:Name
          string:Basic
pinToGroupName  (vnic:Templ:pinToGroupName)
           NO COMMENTS
naming:Name
          string:Basic
statsPolicyName  (vnic:Templ:statsPolicyName)
           NO COMMENTS
network:SwitchId
          scalar:Enum8
switchId  (vnic:Templ:switchId)
           NO COMMENTS
Defined in: policy:Definition
naming:Descr
          string:Basic
descr  (policy:Definition:descr)
           NO COMMENTS
policy:InternalId
          scalar:Uint32
intId  (policy:Definition:intId)
           NO COMMENTS
scalar:Uint32 policyLevel  (policy:Definition:policyLevel)
           policyLevel is used internally by generic policy server.
policy:PolicyOwner
          scalar:Enum8
policyOwner  (policy:Definition:policyOwner)
           "local" denotes policy created by local policy client, "policy" denotes a policy created by remote policy server.
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

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

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: "256"
        Allowed Chars:
            Regex: [a-zA-Z0-9\[\]!#$%()*+,-./:;@ _{|}˜?&]+
Comments:
NO COMMENTS

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" />

identPoolName

Type: pool:Name
Primitive Type: string:Basic
Overrides:vnic:Templ:identPoolName
Units: null
Encrypted: false
Access: admin
Category: TopLevelRegular
Policy Reference to: fcpool:Initiators
Property Validators:
    Range:  min: "0"  max: "32"
        Allowed Chars:
            Regex: [a-zA-Z0-9_.:-]+
Comments:
NO COMMENTS

intId

Type: policy:InternalId
Primitive Type: scalar:Uint32
Units: null
Encrypted: false
Access: implicit
Category: TopLevelRegular
Property Validators:
Comments:
NO COMMENTS
Constants
none 0u NO COMMENTS
DEFAULT none(0u) NO COMMENTS

maxDataFieldSize

Type: storage:MaxDataFieldSize
Primitive Type: scalar:Uint32
Units: null
Encrypted: false
Access: admin
Category: TopLevelRegular
Property Validators:
    Range:  min: (long)256l  max: (long)2112l
Comments:
NO COMMENTS
Constants
defaultValue 2048u NO COMMENTS

name

Type: naming:Name
Primitive Type: string:Basic
Overrides:policy:Object:name  |  naming:NamedObject:name
Units: null
Encrypted: false
Naming Property -- [NAMING RULES]
Access: naming
Category: TopLevelRegular
Property Validators:
    Range:  min: "1"  max: "16"
        Allowed Chars:
            Regex: [a-zA-Z0-9_.:-]+
Comments:
NO COMMENTS

nwCtrlPolicyName

Type: naming:Name
Primitive Type: string:Basic
Overrides:vnic:Templ:nwCtrlPolicyName
Units: null
Encrypted: false
Access: implicit
Category: TopLevelRegular
Property Validators:
    Range:  min: "0"  max: "16"
        Allowed Chars:
            Regex: [a-zA-Z0-9_.:-]+
Comments:
NO COMMENTS

operIdentPoolName

Type: reference:Object
Refers: fcpool:Initiators
Units: null
Encrypted: false
Access: oper
Category: TopLevelRegular
Property Validators:
Comments:
NO COMMENTS

operPeerRedundancyTemplName

Type: reference:Object
Refers: vnic:SanConnTempl
Units: null
Encrypted: false
Access: oper
Category: TopLevelRegular
Property Validators:
Comments:
NO COMMENTS

operQosPolicyName

Type: reference:Object
Refers: epqos:Definition
Units: null
Encrypted: false
Access: oper
Category: TopLevelRegular
Property Validators:
Comments:
NO COMMENTS

operStatsPolicyName

Type: reference:Object
Refers: stats:ThresholdPolicy
Units: null
Encrypted: false
Access: oper
Category: TopLevelRegular
Property Validators:
Comments:
NO COMMENTS

peerRedundancyTemplName

Type: naming:Name
Primitive Type: string:Basic
Units: null
Encrypted: false
Access: admin
Category: TopLevelRegular
Policy Reference to: vnic:SanConnTempl
Property Validators:
    Range:  min: "0"  max: "16"
        Allowed Chars:
            Regex: [a-zA-Z0-9_.:-]+
Comments:
NO COMMENTS

pinToGroupName

Type: naming:Name
Primitive Type: string:Basic
Units: null
Encrypted: false
Access: admin
Category: TopLevelRegular
Property Validators:
    Range:  min: "0"  max: "16"
        Allowed Chars:
            Regex: [a-zA-Z0-9_.:-]+
Comments:
NO COMMENTS

policyLevel

Type: scalar:Uint32
Units: null
Encrypted: false
Access: implicit
Category: TopLevelRegular
Property Validators:
Comments:
policyLevel is used internally by generic policy server.

policyOwner

Type: policy:PolicyOwner
Primitive Type: scalar:Enum8
Units: null
Encrypted: false
Access: admin
Category: TopLevelRegular
Property Validators:
Comments:
"local" denotes policy created by local policy client, "policy" denotes a policy created by remote policy server.
Constants
local 0 NO COMMENTS
policy 1 NO COMMENTS
pending-policy 2 NO COMMENTS
DEFAULT local(0) NO COMMENTS

qosPolicyName

Type: naming:Name
Primitive Type: string:Basic
Overrides:vnic:Templ:qosPolicyName
Units: null
Encrypted: false
Access: admin
Category: TopLevelRegular
Policy Reference to: epqos:Definition
Property Validators:
    Range:  min: "0"  max: "16"
        Allowed Chars:
            Regex: [a-zA-Z0-9_.:-]+
Comments:
NO COMMENTS

redundancyPairType

Type: vnic:RedundancyPairType
Primitive Type: scalar:Enum8
Overrides:vnic:Templ:redundancyPairType
Paths: vnic:Template:redundancyPairType
Units: null
Encrypted: false
Access: admin
Category: TopLevelRegular
Property Validators:
Comments:
NO COMMENTS
Constants
none 1 NO COMMENTS
primary 2 NO COMMENTS
secondary 3 NO COMMENTS
DEFAULT none(1) 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

statsPolicyName

Type: naming:Name
Primitive Type: string:Basic
Units: null
Encrypted: false
Access: admin
Category: TopLevelRegular
Policy Reference to: stats:ThresholdPolicy
Property Validators:
    Range:  min: "0"  max: "16"
        Allowed Chars:
            Regex: [a-zA-Z0-9_.:-]+
Comments:
NO COMMENTS
Constants
defaultValue "default" NO COMMENTS

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.


switchId

Type: network:SwitchId
Primitive Type: scalar:Enum8
Units: null
Encrypted: false
Access: admin
Category: TopLevelRegular
Property Validators:
Comments:
NO COMMENTS
Constants
NONE 0 NO COMMENTS
A 1 NO COMMENTS
B 2 NO COMMENTS
DEFAULT A(1) NO COMMENTS

target

Type: vnic:TemplateTarget
Primitive Type: scalar:Bitmask8
Overrides:vnic:Templ:target
Units: null
Encrypted: false
Access: implicit
Category: TopLevelRegular
Property Validators:
Comments:
NO COMMENTS
Constants
vm 1 add fcoe
adaptor 2 NO COMMENTS
DEFAULT adaptor(2) NO COMMENTS

templType

Type: vnic:TemplateType
Primitive Type: scalar:Enum8
Overrides:vnic:Templ:templType
Paths: vnic:Template:templType
Units: null
Encrypted: false
Access: admin
Category: TopLevelRegular
Property Validators:
Comments:
NO COMMENTS
Constants
initial-template 1 NO COMMENTS
updating-template 2 NO COMMENTS
DEFAULT initial-template(1) NO COMMENTS