Overview  Diagram  Inheritance  Events  Faults  FSMs  Properties Summary  Properties Detail 

Class firmware:Source (ABSTRACT)

Class ID:345
Encrypted: true - Exportable: false - Persistent: true - Configurable: true - Subject to Quota: Disabled - Abstraction Layer: Ambiguous Placement in the Model - APIC NX Processing: Disabled
Write Access: [admin]
Read Access: [admin, fabric-protocol-util]
Creatable/Deletable: yes (see Container Mos for details)
Semantic Scope: Fabric
Semantic Scope Evaluation Rule: Subclasses
Monitoring Policy Source: Parent
Monitoring Flags : [ IsObservable: true, HasStats: false, HasFaults: true, HasHealth: true, HasEventRules: false ]

The firmware source specifications including CCO, and any server (SCP, HTTP, FTP) in which Curl can extract files.

Naming Rules 


DN FORMAT: 

[1] uni/fabric/fwrepop/


Diagram

Super Mo: pol:Comp,
Sub Mos: firmware:CcoSource, firmware:InternalSource, firmware:OSource, vns:SvcPkgSource, vns:VmmConfigFile,
Container Mos: firmware:RepoP (deletable:yes),
Contained Mos: firmware:Download,


Inheritance
[V] naming:NamedObject An abstract base class for an object that contains a name.
 ├
 		[V] pol:Obj Represents a generic policy object.
 
 		 ├
 		[V] pol:Comp Represents a policy component. This object is part of the policy definition.
 
 		 
 		 ├
 		[V] firmware:Source The firmware source specifications including CCO, and any server (SCP, HTTP, FTP) in which Curl can extract files.
 
 		 
 		 
 		 ├
 		[V] firmware:CcoSource Cisco.com is the source of images.
 
 		 
 		 
 		 ├
 		[V] firmware:InternalSource The internal source of firmware images, which contains images that are pre-packaged into the controller.
 
 		 
 		 
 		 ├
 		[V] firmware:OSource An outside source of images, such as an HTTP or SCP server.
 
 		 
 		 
 		 ├
 		[V] vns:SvcPkgSource The services device package installer support for the CLI.
 
 		 
 		 
 		 ├
 		[V] vns:VmmConfigFile 


Events


Faults


Fsms


Properties Summary
Defined in: firmware:Source
firmware:AuthPass
          scalar:Enum8 		authPass  (firmware:Source:authPass)
           The authentication type for the source.
firmware:AuthenticationType
          scalar:Enum8 		authType  (firmware:Source:authType)
           The OSPF authentication type specifier. The type options are; default, md5, none, and simple.
scalar:Bool dnldTaskFlip  (firmware:Source:dnldTaskFlip)
           Download Task Flip.
string:CharBuffer identityPrivateKeyContents  (firmware:Source:identityPrivateKeyContents)
           NO COMMENTS
string:Basic identityPrivateKeyPassphrase  (firmware:Source:identityPrivateKeyPassphrase)
           Passphrase given at the identity key creation.
string:CharBuffer identityPublicKeyContents  (firmware:Source:identityPublicKeyContents)
           Certificate contents for data transfer. Used for credentials.
scalar:Bool loadCatalogIfExistsAndNewer  (firmware:Source:loadCatalogIfExistsAndNewer)
          
string:Password password  (firmware:Source:password)
           The Firmware password or key string.
scalar:Uint32 pollingInterval  (firmware:Source:pollingInterval)
           Polling interval in minutes.
firmware:DownloadProtocol
          scalar:Enum8 		proto  (firmware:Source:proto)
           The Firmware download protocol.
reference:URI
          string:Basic 		url  (firmware:Source:url)
           The firmware URL for the image(s) on the source.
aaa:UserName
          string:Basic 		user  (firmware:Source:user)
           The username for the source.
Defined in: pol:Comp
naming:Descr
          string:Basic 		descr  (pol:Comp:descr)
           Specifies the description of a policy component.
Defined in: pol:Obj
naming:Name
          string:Basic 		name  (pol:Obj:name)
           Overrides:naming:NamedObject:name
           null
Defined in: naming:NamedObject
naming:NameAlias
          string:Basic 		nameAlias  (naming:NamedObject:nameAlias)
           NO COMMENTS
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

authPass

Type: firmware:AuthPass
Primitive Type: scalar:Enum8

Units: null
Encrypted: false
Access: admin
Category: TopLevelRegular
Property Validators:
    Comments:
The authentication type for the source.
Constants
password 0 Password Password based authentication.
key 1 Key Key based authentication.
DEFAULT password(0) Password Password based authentication.




authType

Type: firmware:AuthenticationType
Primitive Type: scalar:Enum8

Units: null
Encrypted: false
Access: admin
Category: TopLevelRegular
Property Validators:
    Comments:
The OSPF authentication type specifier. The type options are; default, md5, none, and simple.
Constants
usePassword 0 Use Password NO COMMENTS
useSshKeyContents 1 Use SSH Public/Private Key Files NO COMMENTS
DEFAULT usePassword(0) Use Password NO COMMENTS




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




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: "128"
        Allowed Chars:
            Regex: [a-zA-Z0-9\\!#$%()*,-./:;@ _{|}~?&+]+
    Comments:
Specifies the description of a policy component.


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.


dnldTaskFlip

Type: scalar:Bool

Units: null
Encrypted: false
Access: admin
Category: TopLevelRegular
Property Validators:
    Comments:
Download Task Flip.
Constants
no false --- NO COMMENTS
yes true --- NO COMMENTS
DEFAULT yes(true) --- NO COMMENTS




identityPrivateKeyContents

Type: string:CharBuffer

Units: null
Encrypted: true
Access: admin
Category: TopLevelRegular
Property Validators:
    Comments:
NO COMMENTS
Constants
defaultValue "" --- NO COMMENTS




identityPrivateKeyPassphrase

Type: string:Basic

Units: null
Encrypted: true
Access: admin
Category: TopLevelRegular
Property Validators:
    Range:  min: "0"  max: "512"
    Comments:
Passphrase given at the identity key creation.
Constants
defaultValue "" --- NO COMMENTS




identityPublicKeyContents

Type: string:CharBuffer

Units: null
Encrypted: true
Access: admin
Category: TopLevelRegular
Property Validators:
    Comments:
Certificate contents for data transfer. Used for credentials.
Constants
defaultValue "" --- NO COMMENTS




loadCatalogIfExistsAndNewer

Type: scalar:Bool

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




name

Type: naming:Name
Primitive Type: string:Basic

Overrides:naming:NamedObject:name

Units: null
Encrypted: false
Access: admin
Category: TopLevelRegular
Property Validators:
    Range:  min: "0"  max: "64"
        Allowed Chars:
            Regex: [a-zA-Z0-9_.:-]+
    Comments:
null


nameAlias

Type: naming:NameAlias
Primitive Type: string:Basic

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


password

Type: string:Password

Units: null
Encrypted: true
Access: admin
Category: TopLevelRegular
Property Validators:
    Comments:
The Firmware password or key string.


pollingInterval

Type: scalar:Uint32

Units: min
Encrypted: false
Access: admin
Category: TopLevelRegular
Property Validators:
    Comments:
Polling interval in minutes.


proto

Type: firmware:DownloadProtocol
Primitive Type: scalar:Enum8

Units: null
Encrypted: false
Access: admin
Category: TopLevelRegular
Property Validators:
    Comments:
The Firmware download protocol.
Constants
scp 0 Secure copy NO COMMENTS
http 1 HTTP NO COMMENTS
usbkey 2 USB key NO COMMENTS
local 3 Factory installed NO COMMENTS
DEFAULT scp(0) Secure copy NO COMMENTS




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.





url

Type: reference:URI
Primitive Type: string:Basic

Units: null
Encrypted: false
Access: admin
Category: TopLevelRegular
Property Validators:
    Range:  min: "0"  max: "512"
    Comments:
The firmware URL for the image(s) on the source.


user

Type: aaa:UserName
Primitive Type: string:Basic

Units: null
Encrypted: false
Access: admin
Category: TopLevelRegular
Property Validators:
    Regex: [a-zA-Z0-9][a-zA-Z0-9_.-]{1,31}
    Comments:
The username for the source.




Overview  Diagram  Inheritance  Events  Faults  FSMs  Properties Summary  Properties Detail