ciena.mcp.nsi_api_v4_tpes_by_tpeid (1.0.4) — module

Install collection

Install with ansible-galaxy collection install ciena.mcp:==1.0.4

Add to requirements.yml

  collections:
    - name: ciena.mcp
      version: 1.0.4

Description

Handle resource of type nsi_api_v4_tpes_by_tpeid

Requirements

• python >= 3.6

Inputs

    
data:
    description:
    - 'Validate attributes are:'
    - ' - C(attributes) (dict): '
    - ' - C(id) (str): The unique identifier for the TPE resource'
    - ' - C(meta) (dict): A metadata object that contains non-standard meta information'
    - ' - C(relationships) (dict): '
    - ' - C(type) (str): The TPE resource type'
    - Used by I(state=['put'])
    type: dict

meta:
    description:
    - A metadata object that contains non-standard meta information
    - 'Validate attributes are:'
    - ' - C(absoluteTotal) (int): The unfiltered total number of entities in the data'
    - ' - C(aggregations) (list): The aggregated data based on a requested aggregation
      name and criteria'
    - ' - C(filtered) (bool): Flags whether the current object is filtered using `fields`
      query param or not'
    - ' - C(missingReferenceIds) (list): The list of missing resource IDs'
    - ' - C(missingReferences) (bool): boolean detailing if the GET FRE tree has any missing
      references'
    - ' - C(total) (int): The total number of entities in the data'
    - Used by I(state=['put'])
    type: dict

state:
    choices:
    - get
    - put
    description: []
    type: str

tpeId:
    description:
    - The TPE identifier
    - Required with I(state=['get', 'put'])
    - Used by I(state=['get', 'put'])
    type: str

fields:
    description:
    - (Optional) List of comma separated fields to be included in the response. Fields
      require full path (i.e. data.attributes.field)
    - Used by I(state=['get'])
    type: str

include:
    description:
    - '(Optional) List of comma separated resources to be side-loaded.  The allowed values
      are: expectations, tpePlanned, tpeDiscovered'
    - Used by I(state=['get'])
    type: str

included:
    description:
    - Referenced sub-resources
    - Used by I(state=['put'])
    type: list