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

Class firmware:Firmware (CONCRETE)

Class ID:351
Class Label: Firmware
Encrypted: false - Exportable: true - Persistent: true - Configurable: true - Subject to Quota: Disabled - Abstraction Layer: Logical Model - APIC NX Processing: Disabled
Write Access: [admin]
Read Access: [admin, fabric-protocol-util]
Creatable/Deletable: no (see Container Mos for details)
Semantic Scope: None
Semantic Scope Evaluation Rule: Parent
Monitoring Policy Source: Parent
Monitoring Flags : [ IsObservable: true, HasStats: false, HasFaults: true, HasHealth: true, HasEventRules: false ]

The firmware specification.

Naming Rules 
RN FORMAT: fw-{name}

    [1] PREFIX=fw- PROPERTY = name




DN FORMAT: 

[0] fwrepo/fw-{name}


Diagram

Container Mos: firmware:Repo (deletable:no),
Contained Mos: aaa:RbacAnnotation, tag:Annotation, tag:Tag,
Relations From: pol:DefRelnHolder,
Relations: firmware:RtFirmware, firmware:RtFwFw, firmware:RtPlgnFirmware,


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] firmware:Repo The firmware repository contains all downloaded and available firmware images.
 
 		 ├
 		[V] firmware:Firmware The firmware specification.


Contained Hierarchy
[V] firmware:Firmware The firmware specification.
 ├
 		[V] aaa:RbacAnnotation  RbacAnnotation is used for capturing rbac properties of any apic object Objects can append rbacannotations as Object->RbacAnnotation which is then checked for domain eligibility
 ├
 		[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] aaa:RbacAnnotation  RbacAnnotation is used for capturing rbac properties of any apic object Objects can append rbacannotations as Object->RbacAnnotation which is then checked for domain eligibility
 
 		 ├
 		[V] tag:Annotation 
 
 		 ├
 		[V] tag:Tag 
 ├
 		[V] firmware:RtFirmware A target relation to the firmware specification.
 ├
 		[V] firmware:RtFwFw 
 ├
 		[V] firmware:RtPlgnFirmware 
 ├
 		[V] health:Inst A base class for a health score instance.(Switch only)
 ├
 		[V] tag:Annotation 
 ├
 		[V] tag:Tag 


Inheritance
[V] firmware:Firmware The firmware specification.


Events 
                firmware:Firmware:creation__firmware_Firmware

                firmware:Firmware:modification__firmware_Firmware

                firmware:Firmware:deletion__firmware_Firmware


Faults


Fsms


Properties Summary
Defined in: firmware:Firmware
mo:Annotation
          string:Basic 		annotation  (firmware:Firmware:annotation)
           NO COMMENTS
scalar:Bool autoloadCatalog  (firmware:Firmware:autoloadCatalog)
          
string:Basic checksum  (firmware:Firmware:checksum)
           Displays the firmware checksum.
scalar:Bool deleteIt  (firmware:Firmware:deleteIt)
           A property for deleting firmware (when set to true). For internal use only.
string:Basic description  (firmware:Firmware:description)
           The firmware description.
firmware:DnldStatus
          scalar:Enum8 		dnldStatus  (firmware:Firmware:dnldStatus)
           A property that indicates the firmware download status from a specific source.
scalar:Date downloadDate  (firmware:Firmware:downloadDate)
           The download date.
mo:ExtMngdByType
          scalar:Bitmask32 		extMngdBy  (firmware:Firmware:extMngdBy)
           NO COMMENTS
cap:Version
          string:Basic 		fullVersion  (firmware:Firmware:fullVersion)
          
reference:URI
          string:Basic 		iUrl  (firmware:Firmware:iUrl)
           The internal firmware URL.
firmware:Name
          string:Basic 		isoname  (firmware:Firmware:isoname)
           The name of the ISO file containing the firmware.
scalar:Bool latest  (firmware:Firmware:latest)
           A property that indicates whether the latest minor version.
cap:Version
          string:Basic 		minorVersion  (firmware:Firmware:minorVersion)
           The firmware minor version.
firmware:Name
          string:Basic 		name  (firmware:Firmware:name)
           The firmware name.
scalar:Date releaseDate  (firmware:Firmware:releaseDate)
           The firmware release date.
scalar:Uint32 size  (firmware:Firmware:size)
           The size of the firmware image.
scalar:Uint64 size64  (firmware:Firmware:size64)
           Firmware size to handle large file sizes (> 4GB)
firmware:Type
          scalar:Enum8 		type  (firmware:Firmware:type)
           The firmware type.
reference:URI
          string:Basic 		url  (firmware:Firmware:url)
           The external firmware URL.
cap:Version
          string:Basic 		version  (firmware:Firmware:version)
           The firmware major version.
Defined in: mo:Ownable
scalar:Uint16 uid  (mo:Ownable:uid)
           A unique identifier for this object.
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:Modifiable
mo:TStamp
          scalar:Date 		modTs  (mo:Modifiable:modTs)
           The time when this object was last modified.
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.
Properties Detail

annotation

Type: mo:Annotation
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:
NO COMMENTS


autoloadCatalog

Type: scalar:Bool

Units: null
Encrypted: false
Access: implicit
Category: TopLevelRegular
    Comments:
Constants
no false --- NO COMMENTS
yes true --- NO COMMENTS
DEFAULT no(false) --- NO COMMENTS




checksum

Type: string:Basic

Units: null
Encrypted: false
Access: implicit
Category: TopLevelRegular
    Comments:
Displays the firmware checksum.


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




deleteIt

Type: scalar:Bool

Units: null
Encrypted: false
Access: admin
Category: TopLevelRegular
Property Validators:
    Comments:
A property for deleting firmware (when set to true). For internal use only.
Constants
no false --- NO COMMENTS
yes true --- NO COMMENTS
DEFAULT no(false) --- NO COMMENTS




description

Type: string:Basic

Units: null
Encrypted: false
Access: implicit
Category: TopLevelRegular
    Comments:
The firmware description.


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.


dnldStatus

Type: firmware:DnldStatus
Primitive Type: scalar:Enum8

Units: null
Encrypted: false
Access: implicit
Category: TopLevelRegular
    Comments:
A property that indicates the firmware download status from a specific source.
Constants
not-queued 0 Not queued NO COMMENTS
queued 1 Queued NO COMMENTS
downloading 2 Downloading NO COMMENTS
downloaded 3 Downloaded NO COMMENTS
download-failed 4 Download failed NO COMMENTS
DEFAULT not-queued(0) Not queued NO COMMENTS




downloadDate

Type: scalar:Date

Units: null
Encrypted: false
Access: implicit
Category: TopLevelRegular
    Comments:
The download date.


extMngdBy

Type: mo:ExtMngdByType
Primitive Type: scalar:Bitmask32

Units: null
Encrypted: false
Access: implicit
Category: TopLevelRegular
    Comments:
NO COMMENTS
Constants
undefined 0u undefined NO COMMENTS
msc 1u msc NO COMMENTS
DEFAULT undefined(0u) undefined NO COMMENTS




fullVersion

Type: cap:Version
Primitive Type: string:Basic

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


iUrl

Type: reference:URI
Primitive Type: string:Basic

Units: null
Encrypted: false
Access: implicit
Category: TopLevelRegular
    Comments:
The internal firmware URL.


isoname

Type: firmware:Name
Primitive Type: string:Basic

Units: null
Encrypted: false
Access: implicit
Category: TopLevelRegular
    Comments:
The name of the ISO file containing the firmware.


latest

Type: scalar:Bool

Units: null
Encrypted: false
Access: admin
Category: TopLevelRegular
Property Validators:
    Comments:
A property that indicates whether the latest minor version.
Constants
no false --- NO COMMENTS
yes true --- NO COMMENTS
DEFAULT no(false) --- 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




minorVersion

Type: cap:Version
Primitive Type: string:Basic

Units: null
Encrypted: false
Access: implicit
Category: TopLevelRegular
    Comments:
The firmware minor version.


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




name

Type: firmware:Name
Primitive Type: string:Basic

Units: null
Encrypted: false
Naming Property -- [NAMING RULES]
Access: naming
Category: TopLevelRegular
Property Validators:
    Range:  min: "1"  max: "512"
    Comments:
The firmware name.


releaseDate

Type: scalar:Date

Units: null
Encrypted: false
Access: implicit
Category: TopLevelRegular
    Comments:
The firmware release date.


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.


size

Type: scalar:Uint32

Units: bytes
Encrypted: false
Access: implicit
Category: TopLevelRegular
    Comments:
The size of the firmware image.


size64

Type: scalar:Uint64

Units: bytes
Encrypted: false
Access: implicit
Category: TopLevelRegular
    Comments:
Firmware size to handle large file sizes (> 4GB)


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.





type

Type: firmware:Type
Primitive Type: scalar:Enum8

Units: null
Encrypted: false
Access: implicit
Category: TopLevelRegular
    Comments:
The firmware type.
Constants
controller 0 Controller Controller software
switch 1 Switch Switch software
catalog 2 Catalog Catalog
plugin 3 Plugin Plugin
pluginPackage 4 PluginPackage PluginPackage
config 5 Config ConfigFile
vpod 6 vPod VPod (vspine/vleaf software )
DEFAULT switch(1) Switch Switch software




uid

Type: scalar:Uint16

Units: null
Encrypted: false
Access: implicit
Category: TopLevelRegular
    Comments:
A unique identifier for this object.


url

Type: reference:URI
Primitive Type: string:Basic

Units: null
Encrypted: false
Access: implicit
Category: TopLevelRegular
    Comments:
The external firmware URL.


version

Type: cap:Version
Primitive Type: string:Basic

Units: null
Encrypted: false
Access: implicit
Category: TopLevelRegular
    Comments:
The firmware major version.




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