ciena.mcp.nsi_api_v6_tpes (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_v6_tpes

Requirements

• python >= 3.6

Inputs

    
id:
    description:
    - (Optional) Comma separated list of TPE identifiers to retrieve
    - Used by I(state=['get'])
    type: str

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=['post'])
    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=['post'])
    type: dict

limit:
    description:
    - The size of a returned page. Defaulted to return 30 TPEs at once.
    - Used by I(state=['get'])
    type: str

state:
    choices:
    - get
    - post
    description: []
    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

offset:
    description:
    - Offset for the second page
    - Used by I(state=['get'])
    type: str

content:
    choices:
    - detail
    - summary
    description:
    - (Optional) The TPE content level
    - 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, concrete'
    - Used by I(state=['get'])
    type: str

concrete:
    description:
    - (Optional) Id of the concrete tpe
    - Used by I(state=['get'])
    type: str

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

location:
    description:
    - (Optional) TPE location - shelf-slot-port or slot-port or port. Only applied when
      Network Construct identifier is provided.
    - Used by I(state=['get'])
    type: str

equipmentId:
    description:
    - (Optional) Equipment identifier. In case of usage with limit parameter, paging will
      be enabled.
    - Used by I(state=['get'])
    type: str

structureType:
    description:
    - (Optional) TPE structure type. Only applied when Network Construct identifier is
      provided.
    - Used by I(state=['get'])
    type: str

locationFormat:
    description:
    - (Optional) Format for the given location; when not given, assume location is [[shelf-]slot-]port.
      Only applied when Network Construct identifier is provided.
    - Used by I(state=['get'])
    type: str

networkConstruct.id:
    description:
    - (Optional) Network Construct identifier. In case of usage with limit parameter,
      paging will be enabled.
    - Used by I(state=['get'])
    type: str

tpeExpectations.intent.id:
    description:
    - (Optional) The intent Id
    - Used by I(state=['get'])
    type: str

tpeExpectations.serviceIntent.id:
    description:
    - (Optional) The service intent Id
    - Used by I(state=['get'])
    type: str

tpeExpectations.equipmentIntent.id:
    description:
    - (Optional) The equipment intent Id
    - Used by I(state=['get'])
    type: str