Class config:SubJob (CONCRETE)

Class ID:262
Class Label: Subjob
Encrypted: false - Exportable: false - Persistent: true - Configurable: false - Subject to Quota: Disabled
Write Access: [NON CONFIGURABLE]
Read Access: [admin]
Creatable/Deletable: no (see Container Mos for details)
Semantic Scope: Fabric
Semantic Scope Evaluation Rule: Parent
Monitoring Policy Source: Parent
Monitoring Flags : [ IsObservable: true, HasStats: false, HasFaults: true, HasHealth: true, HasEventRules: false ]

The sub job.

Naming Rules
RN FORMAT: job-{type}-shard-{destShard}

    [1] PREFIX=job- PROPERTY = type


    [2] PREFIX=-shard- PROPERTY = destShard




DN FORMAT: 

[1] uni/backupst/jobs-{[pDn]}/run-{name}/job-{type}-shard-{destShard}

                


Diagram

Super Mo: pol:Comp,
Container Mos: config:Job (deletable:no),


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] fabric:Topology The root for IFC topology.
 
 ├
[V] fabric:Pod A pod.
 
 
 ├
[V] fabric:Node The root node for the APIC.
 
 
 
 ├
[V] ctx:Local The local Context.
 
 
 
 
 ├
[V] ctx:Application The context application.
 
 
 
 
 
 ├
[V] pol:Uni Represents policy definition/resolution universe.
 
 
 
 
 
 
 ├
[V] config:BackupStatusCont The backup status container.
 
 
 
 
 
 
 
 ├
[V] config:JobCont The configuration job container.
 
 
 
 
 
 
 
 
 ├
[V] config:Job The configuration job.
 
 
 
 
 
 
 
 
 
 ├
[V] config:SubJob The sub job.
[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] pol:Uni Represents policy definition/resolution universe.
 
 ├
[V] config:BackupStatusCont The backup status container.
 
 
 ├
[V] config:JobCont The configuration job container.
 
 
 
 ├
[V] config:Job The configuration job.
 
 
 
 
 ├
[V] config:SubJob The sub job.


Contained Hierarchy
[V] config:SubJob The sub job.
 ├
[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:Delegate Exposes internal faults to the user. A fault delegate object can be defined on IFC (for example, for an endpoint group) and when the fault is raised (for example, under an endpoint policy on a switch), a fault delegate object is created on IFC under the specified object. A fault delegate object follows the lifecycle of the original fault instance object, being created, modified, or deleted based on the changes of the original fault.
 ├
[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] health:Inst A base class for a health score instance.(Switch only)


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] config:SubJob The sub job.


Events
                


Faults
                


Fsms
                


Properties Summary
Defined in: config:SubJob
mo:ShardId
          scalar:UByte
destShard  (config:SubJob:destShard)
           null
naming:LongDescr
          string:Basic
details  (config:SubJob:details)
           null
scalar:Date executeTime  (config:SubJob:executeTime)
           null
reference:BinRef monPolDn  (config:SubJob:monPolDn)
           The monitoring policy attached to this observable object.
config:OperSt
          scalar:Enum8
operSt  (config:SubJob:operSt)
           null
scalar:Uint32 retriesUsed  (config:SubJob:retriesUsed)
           An internal count of how many times this export job has retried.
config:SubJobType
          scalar:Enum8
type  (config:SubJob:type)
           null
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.
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.
Properties Detail

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
    Comments:
Specifies the description of a policy component.



destShard

Type: mo:ShardId
Primitive Type: scalar:UByte

Units: null
Encrypted: false
Naming Property -- [NAMING RULES]
Access: naming
Category: TopLevelRegular
    Comments:
null
Constants
undefined 0 Undefined NO COMMENTS
local 255 Local NO COMMENTS
DEFAULT undefined(0) Undefined NO COMMENTS





details

Type: naming:LongDescr
Primitive Type: string:Basic

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



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.



executeTime

Type: scalar:Date

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



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





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





monPolDn

Type: reference:BinRef

Units: null
Encrypted: false
Access: implicit
Category: TopLevelRegular
    Comments:
The monitoring policy attached to this observable object.



name

Type: naming:Name
Primitive Type: string:Basic

Overrides:naming:NamedObject:name
Units: null Encrypted: false Access: admin Category: TopLevelRegular
    Comments:
null



nameAlias

Type: naming:NameAlias
Primitive Type: string:Basic

Units: null
Encrypted: false
Access: admin
Category: TopLevelRegular
    Comments:
NO COMMENTS



operSt

Type: config:OperSt
Primitive Type: scalar:Enum8

Units: null
Encrypted: false
Access: implicit
Category: TopLevelRegular
    Comments:
null
Constants
pending 0 pending NO COMMENTS
running 1 running NO COMMENTS
success 2 success NO COMMENTS
success-with-warnings 3 success-with-warnings NO COMMENTS
timeout 4 timeout NO COMMENTS
failed 5 failed NO COMMENTS
fail-no-retry 6 fail-no-retry NO COMMENTS
fail-no-data 7 fail-no-data NO COMMENTS
retry 8 retry NO COMMENTS
DEFAULT pending(0) pending NO COMMENTS





retriesUsed

Type: scalar:Uint32

Units: null
Encrypted: false
Access: implicit
Category: TopLevelRegular
    Comments:
An internal count of how many times this export job has retried.



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.






type

Type: config:SubJobType
Primitive Type: scalar:Enum8

Units: null
Encrypted: false
Naming Property -- [NAMING RULES]
Access: naming
Category: TopLevelRegular
    Comments:
null
Constants
import-authentication 0 import-authentication NO COMMENTS
export-authentication 1 export-authentication NO COMMENTS
import-data 2 import-data NO COMMENTS
export-data 3 export-data NO COMMENTS
import-ids 4 import-ids NO COMMENTS
import-dhcp-data 5 import-dhcp-data NO COMMENTS
DEFAULT export-authentication(1) export-authentication NO COMMENTS