Class ap:Plugin (CONCRETE)

Class ID:8929
Class Label: Information about APIC app
Encrypted: true - Exportable: true - Persistent: true - Configurable: true - Subject to Quota: Disabled
Write Access: [admin, nw-svc-device]
Read Access: [admin, nw-svc-device]
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 ]

Plugin Info

Naming Rules
RN FORMAT: plugin-{appCtxRoot}

    [1] PREFIX=plugin- PROPERTY = appCtxRoot




DN FORMAT: 

[0] pluginContr/plugin-{appCtxRoot}

                


Diagram

Super Mo: ap:PluginName,
Container Mos: ap:PluginContr (deletable:no),
Contained Mos: ap:PluginAppliance, ap:UiInfo,
Relations To: infra:ClusterPol,
Relations: ap:RsClusterPolicy,


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] ap:PluginContr  Plugin Container
 
 ├
[V] ap:Plugin  Plugin Info


Contained Hierarchy
[V] ap:Plugin  Plugin Info
 ├
[V] ap:PluginAppliance 
 ├
[V] ap:RsClusterPolicy 
 
 ├
[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] health:Inst A base class for a health score instance.(Switch only)
 ├
[V] ap:UiInfo 
 
 ├
[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: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] 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] ap:PluginName  Abstract meta configuration information base
 
 ├
[V] ap:Plugin  Plugin Info


Events
                ap:Plugin:creation__ap_Plugin
ap:Plugin:modification__ap_Plugin
ap:Plugin:deletion__ap_Plugin


Faults
                ap:Plugin:AppDowngradeNotAllowed
ap:Plugin:SignatureVerificationFailed
ap:Plugin:StartPluginFailed
ap:Plugin:ValidationFailed


Fsms
                


Properties Summary
Defined in: ap:Plugin
string:Basic appCtxRoot  (ap:Plugin:appCtxRoot)
           app Context Root
string:Basic appId  (ap:Plugin:appId)
           An application SAP ID.
ap:UserCertDataType
          string:CharBuffer
cert  (ap:Plugin:cert)
           Plugin user certificate
string:Basic configInfo  (ap:Plugin:configInfo)
           The configuration issues found during graph rendering.
ap:ConfIssuesType
          scalar:Bitmask64
configIssues  (ap:Plugin:configIssues)
           Bitmask representation of the configuration issues found during the endpoint group deployment.
ap:ConfSt
          scalar:Enum8
configSt  (ap:Plugin:configSt)
           The configuration state of the endpoint profile.
string:Basic ctrlrVersion  (ap:Plugin:ctrlrVersion)
           APIC version
string:Basic description  (ap:Plugin:description)
           Plugin ID
ap:DockerImageName
          string:CharBuffer
dockerImage  (ap:Plugin:dockerImage)
           Docker Image Name
ap:UserKeyDataType
          string:CharBuffer
key  (ap:Plugin:key)
           The key or password used to uniquely identify this configuration object.
string:Basic permissions  (ap:Plugin:permissions)
           Permissions needed for plug-in operation
string:Basic permissionsLevel  (ap:Plugin:permissionsLevel)
           NO COMMENTS
ap:PluginState
          scalar:Enum8
pluginSt  (ap:Plugin:pluginSt)
          
ap:PluginType
          scalar:Enum8
pluginType  (ap:Plugin:pluginType)
           NO COMMENTS
string:Basic role  (ap:Plugin:role)
           The system role type.
string:Basic securityDomains  (ap:Plugin:securityDomains)
           NO COMMENTS
string:Basic signature  (ap:Plugin:signature)
           Signature
string:Basic username  (ap:Plugin:username)
           Name of plugin user
string:Basic vendor  (ap:Plugin:vendor)
           Vendor Name
string:Basic vendorId  (ap:Plugin:vendorId)
           The DHCP vendor identifier.
ap:VerifySignature
          scalar:Enum8
verifySignature  (ap:Plugin:verifySignature)
           Verify Signature
string:Basic version  (ap:Plugin:version)
           The version of the compatibility catalog.
Defined in: ap:PluginName
naming:Name
          string:Basic
name  (ap:PluginName:name)
           Overrides:naming:NamedObject:name
          
Defined in: naming:NamedObject
naming:NameAlias
          string:Basic
nameAlias  (naming:NamedObject:nameAlias)
           NO COMMENTS
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: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:Modifiable
mo:TStamp
          scalar:Date
modTs  (mo:Modifiable:modTs)
           The time when this object was last modified.
Defined in: mo:Ownable
scalar:Uint16 uid  (mo:Ownable:uid)
           A unique identifier for this object.
Properties Detail

appCtxRoot

Type: string:Basic

Units: null
Encrypted: false
Naming Property -- [NAMING RULES]
Access: naming
Category: TopLevelRegular
Property Validators:
    Range:  min: "1"  max: "512"
    Comments:
app Context Root



appId

Type: string:Basic

Units: null
Encrypted: false
Access: implicit
Category: TopLevelRegular
    Comments:
An application SAP ID.



cert

Type: ap:UserCertDataType
Primitive Type: string:CharBuffer

Units: null
Encrypted: false
Access: implicit
Category: TopLevelRegular
    Comments:
Plugin user certificate



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





configInfo

Type: string:Basic

Units: null
Encrypted: false
Access: oper
Category: TopLevelRegular
Property Validators:
    Range:  min: "0"  max: "512"
    Comments:
The configuration issues found during graph rendering.



configIssues

Type: ap:ConfIssuesType
Primitive Type: scalar:Bitmask64

Units: null
Encrypted: false
Access: implicit
Category: TopLevelRegular
    Comments:
Bitmask representation of the configuration issues found during the endpoint group deployment.
Constants
ok 0ull ok NO COMMENTS
invalid-meta-data 0x1ull invalid meta data NO COMMENTS
start-plugin-failed 0x2ull start plugin failed NO COMMENTS
app-downgrade-not-allowed 0x4ull app downgrade not allowed NO COMMENTS
signature-verification-failed 0x8ull signature verification failed NO COMMENTS
DEFAULT ok(0ull) ok NO COMMENTS





configSt

Type: ap:ConfSt
Primitive Type: scalar:Enum8

Units: null
Encrypted: false
Access: admin
Category: TopLevelRegular
Property Validators:
    Comments:
The configuration state of the endpoint profile.
Constants
none 0 none NO COMMENTS
initializing 1 initializing NO COMMENTS
initialized 2 initialized NO COMMENTS
failed-to-initialize 3 failed-to-initialize NO COMMENTS
DEFAULT none(0) none NO COMMENTS





ctrlrVersion

Type: string:Basic

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



description

Type: string:Basic

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



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.



dockerImage

Type: ap:DockerImageName
Primitive Type: string:CharBuffer

Units: null
Encrypted: false
Access: implicit
Category: TopLevelRegular
    Comments:
Docker Image Name



key

Type: ap:UserKeyDataType
Primitive Type: string:CharBuffer

Units: null
Encrypted: true
Access: implicit
Category: TopLevelRegular
    Comments:
The key or password used to uniquely identify this configuration object.



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





name

Type: naming:Name
Primitive Type: string:Basic

Overrides:naming:NamedObject:name
Units: null Encrypted: false Access: admin Category: TopLevelRegular Property Validators: Range: min: "1" max: "128" Allowed Chars: Regex: [a-zA-Z0-9_.:-]+
    Comments:



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



permissions

Type: string:Basic

Units: null
Encrypted: false
Access: implicit
Category: TopLevelRegular
    Comments:
Permissions needed for plug-in operation



permissionsLevel

Type: string:Basic

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



pluginSt

Type: ap:PluginState
Primitive Type: scalar:Enum8

Units: null
Encrypted: false
Access: admin
Category: TopLevelRegular
Property Validators:
    Comments:
Constants
inactive 0 inactive NO COMMENTS
active 1 active NO COMMENTS
DEFAULT 0 --- NO COMMENTS





pluginType

Type: ap:PluginType
Primitive Type: scalar:Enum8

Units: null
Encrypted: false
Access: admin
Category: TopLevelRegular
Property Validators:
    Comments:
NO COMMENTS
Constants
Stateless 0 Stateless NO COMMENTS
Stateful 1 Stateful NO COMMENTS
DEFAULT 0 --- 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.



role

Type: string:Basic

Units: null
Encrypted: false
Access: admin
Category: TopLevelRegular
Property Validators:
    Range:  min: "0"  max: "512"
    Comments:
The system role type.



securityDomains

Type: string:Basic

Units: null
Encrypted: false
Access: admin
Category: TopLevelRegular
Property Validators:
    Range:  min: "0"  max: "512"
    Comments:
NO COMMENTS



signature

Type: string:Basic

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



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.






uid

Type: scalar:Uint16

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



username

Type: string:Basic

Units: null
Encrypted: false
Access: admin
Category: TopLevelRegular
Property Validators:
    Range:  min: "0"  max: "512"
    Comments:
Name of plugin user



vendor

Type: string:Basic

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



vendorId

Type: string:Basic

Units: null
Encrypted: false
Access: implicit
Category: TopLevelRegular
    Comments:
The DHCP vendor identifier.



verifySignature

Type: ap:VerifySignature
Primitive Type: scalar:Enum8

Units: null
Encrypted: false
Access: implicit
Category: TopLevelRegular
    Comments:
Verify Signature
Constants
disable 0 disable NO COMMENTS
enable 1 enable NO COMMENTS
DEFAULT disable(0) disable NO COMMENTS





version

Type: string:Basic

Units: null
Encrypted: false
Access: implicit
Category: TopLevelRegular
    Comments:
The version of the compatibility catalog.