.. Class Doc file

class cobra.model.vns.MParam
============================
.. class:: cobra.model.vns.MParam

A meta parameter. The model utilizes a generic configuration consisting of MFolders and MParams. This enables configuration to be specified as a hierarchy. The metadata within this model consists of a key, a type (integer, boolean), and other attributes related to parameters.

    Containers:
      * :class:`cobra.model.vns.MFolder`

    Containment:
      * :class:`cobra.model.fault.Counts`
      * :class:`cobra.model.health.Inst`
      * :class:`cobra.model.vns.Composite`
      * :class:`cobra.model.vns.Range`
      * :class:`cobra.model.vns.RsConnector`
      * :class:`cobra.model.vns.Comparison`

    Properties:
      - cardinality : The cardinality of the meta parameter. This attribute specifies the number of instances of this parameter that can exist. Instances are distinguished by their names.

          + isNaming: False
          + isCreateOnly: False
          + isConfig: False
          + isImplicit: True

      - childAction : Delete or ignore. For internal use only.

          + isNaming: False
          + isCreateOnly: False
          + isConfig: False
          + isImplicit: True

      - dType : The data type for this parameter. For example, string, integer, and boolean are typical data types used with parameters.

          + isNaming: False
          + isCreateOnly: False
          + isConfig: False
          + isImplicit: True

      - description : The description of this configuration item. This attribute is primarily used by the graphical user interface (GUI) to describe a parameter.

          + isNaming: False
          + isCreateOnly: False
          + isConfig: False
          + isImplicit: True

      - dispFeature : 

          + isNaming: False
          + isCreateOnly: False
          + isConfig: False
          + isImplicit: True

      - dispLabel : 

          + isNaming: False
          + isCreateOnly: False
          + isConfig: False
          + isImplicit: True

      - dispType : 

          + isNaming: False
          + isCreateOnly: False
          + isConfig: False
          + isImplicit: True

      - dn : A tag or metadata is a non-hierarchical keyword or term assigned to the fabric module.

          + isNaming: False
          + isCreateOnly: True
          + isConfig: False
          + isImplicit: True

      - key : The key for the meta parameter. This property uniquely identifies the parameter.

          + isNaming: True
          + isCreateOnly: True
          + isConfig: True
          + isImplicit: False

      - lcOwn : This property is managed internally and should not be modified by the user.

          + isNaming: False
          + isCreateOnly: False
          + isConfig: False
          + isImplicit: True

      - mandatory : The value that specifies if this parameter is mandatory. This property is a boolean value (yes or no), and can be used with get and set operations.

          + isNaming: False
          + isCreateOnly: False
          + isConfig: False
          + isImplicit: True

      - modTs : The modification time stamp.

          + isNaming: False
          + isCreateOnly: False
          + isConfig: False
          + isImplicit: True

      - monPolDn : The monitoring policy attached to this observable object.

          + isNaming: False
          + isCreateOnly: False
          + isConfig: False
          + isImplicit: True

      - name : The name of the parameter.  It is used to identify parameters where the cardinality allows the creation of multiple instances.

          + isNaming: False
          + isCreateOnly: False
          + isConfig: True
          + isImplicit: False

      - rn : Identifies an object from its siblings within the context of its parent object. The distinguished name contains a sequence of relative names.

          + isNaming: False
          + isCreateOnly: True
          + isConfig: False
          + isImplicit: True

      - status : The upgrade status. This property is for internal use only.

          + isNaming: False
          + isCreateOnly: False
          + isConfig: False
          + isImplicit: True

      - validation : The validation expression. The validation expression is a string specifying the valid values for the parameter.

          + isNaming: False
          + isCreateOnly: False
          + isConfig: False
          + isImplicit: True