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

Class license:SourceFile (CONCRETE)

Class ID:1068
Encrypted: false - Exportable: false - Persistent: true
Privileges: [read-only]
SNMP OID: .1.3.6.1.4.1.9.9.719.1.66.12

NO COMMENTS

Naming Rules 
RN FORMAT: src-[id]:[line]

    [1] PREFIX=src- PROPERTY = id


    [2] PREFIX=: PROPERTY = line




DN FORMAT: 

[0] sys/license/feature-[name]-[vendor]-[version]/inst-[scope]/src-[id]:[line]


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.
 ├
 		top:System Provides general information about this system, such as the name, IP address and current time.
 
 		 ├
 		license:Ep The system-level endpoint for licensing contains Mos representing the system-wide properties of licensable features. It is a singleton.
 
 		 
 		 ├
 		license:Feature A system-wide representation of a licensable feature exists to specify system-wide properties of that feature. It is identified by the {name, vendor, version} triplet.
 
 		 
 		 
 		 ├
 		license:Instance Instance MOs correspond to actual FLEXlm (or other) licenses supplied by the user in a license file. Licenses are uniquely identified by the {fileId, lineId} pair.
 
 		 
 		 
 		 
 		 ├
 		license:SourceFile


Contained Hierarchy
license:SourceFile
Inheritance
license:SourceFile
Events


Faults


Fsms


Properties Summary
Defined in: license:SourceFile
license:Expiration
          scalar:Date 		exp  (license:SourceFile:exp)
           The expiration date of the license. Set to zero if the license is perpetual.
license:HostId
          string:Basic 		hostId  (license:SourceFile:hostId)
           All licenses are "node locked", meaning they are valid only for a specific switch (where "node" means "switch"). The node is identified by the switch's serial number, called "host id" in licensing parlance.
license:Id
          string:Basic 		id  (license:SourceFile:id)
           The license file id is the only naming property for license files. It is globally unique and is availble through 'LicFileID' tag in license files.
license:FileLine
          string:Basic 		line  (license:SourceFile:line)
           The license is uniquely identified within a license file by its line id.
license:PAK
          string:Basic 		pak  (license:SourceFile:pak)
           The user presents a Product Authorization Key (PAK) when requesting a license. The PAK is embedded in the returned license.
license:Quant
          scalar:Uint32 		quant  (license:SourceFile:quant)
           Counted licenses represent a quantity of resources licensed by the user. Set to zero if not a counted license.
license:Signature
          string:Basic 		sig  (license:SourceFile:sig)
           The license generator signs each license, typically in the form of a 12 character hex string.
license:Type
          scalar:Enum8 		type  (license:SourceFile:type)
           The type of license (e.g., INCREMENT).
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

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

exp

Type: license:Expiration
Primitive Type: scalar:Date
Units: null
Encrypted: false
Access: implicit
Category: TopLevelRegular
Property Validators:

Comments:
The expiration date of the license. Set to zero if the license is perpetual.
Constants
never 999999ull NO COMMENTS
DEFAULT never(999999ull) NO COMMENTS

hostId

Type: license:HostId
Primitive Type: string:Basic
Units: null
Encrypted: false
Access: implicit
Category: TopLevelRegular
Property Validators:
    Range:  min: "0"  max: "16"
        Allowed Chars:
            Regex: [a-zA-Z0-9_.:-]+

Comments:
All licenses are "node locked", meaning they are valid only for a specific switch (where "node" means "switch"). The node is identified by the switch's serial number, called "host id" in licensing parlance.

id

Type: license:Id
Primitive Type: string:Basic
Units: null
Encrypted: false
Naming Property -- [NAMING RULES]
Access: naming
Category: TopLevelRegular
Property Validators:
    Range:  min: "1"  max: "32"

Comments:
The license file id is the only naming property for license files. It is globally unique and is availble through 'LicFileID' tag in license files.

line

Type: license:FileLine
Primitive Type: string:Basic
Units: null
Encrypted: false
Naming Property -- [NAMING RULES]
Access: naming
Category: TopLevelRegular
Property Validators:
    Range:  min: "1"  max: "510"

Comments:
The license is uniquely identified within a license file by its line id.

pak

Type: license:PAK
Primitive Type: string:Basic
Units: null
Encrypted: false
Access: implicit
Category: TopLevelRegular
Property Validators:
    Range:  min: "0"  max: "510"

Comments:
The user presents a Product Authorization Key (PAK) when requesting a license. The PAK is embedded in the returned license.

quant

Type: license:Quant
Primitive Type: scalar:Uint32
Units: null
Encrypted: false
Access: implicit
Category: TopLevelRegular
Property Validators:

Comments:
Counted licenses represent a quantity of resources licensed by the user. Set to zero if not a counted license.
Constants
defaultValue 0u 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

sig

Type: license:Signature
Primitive Type: string:Basic
Units: null
Encrypted: false
Access: implicit
Category: TopLevelRegular
Property Validators:
    Range:  min: "0"  max: "510"

Comments:
The license generator signs each license, typically in the form of a 12 character hex string.

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.

type

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

Comments:
The type of license (e.g., INCREMENT).
Constants
increment 0 NO COMMENTS
upgrade 1 NO COMMENTS
feature 2 NO COMMENTS
DEFAULT increment(0) NO COMMENTS
Overview  Containers  Contained  Inheritance  Events  Faults  FSMs  Properties Summary  Properties Detail  Naming