ciena.mcp.nsi_api_v4_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_v4_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
    - Used by I(state=['get'])
    type: str

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

active:
    choices:
    - 'false'
    - 'true'
    description:
    - (Optional) The active state of the resource
    - Used by I(state=['get'])
    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

sortBy:
    description:
    - (Optional) List of comma separated fields by which to sort the result. Fields require
      full path (i.e. data.attributes.field). A dash or negative sign before a field indicates
      descending order; by default ascending order is used
    - 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, concrete, networkConstructs'
    - 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 delimited by dashes
    - Used by I(state=['get'])
    type: str

modelType:
    description:
    - (Optional) modelType parameter used to filter results
    - Used by I(state=['get'])
    type: str

namedQuery:
    description:
    - '(Optional) Comma-separated named query id list; The allowed values are: portsL2AvailableAll,
      portsL2ApplicableEPLUni, portsL2ApplicableEVPLUni, portsL2ApplicableEnni, portsL2ApplicableEPLUniWithMcLag,
      portsL2ApplicableEVPLUniWithMcLag, portsL2ApplicableEnniWithMcLag, portsTunnelsL2ApplicableAll,
      portsTDMCEApplicableAll'
    - Used by I(state=['get'])
    type: str

searchText:
    description:
    - (Optional) The searchable text
    - 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

searchFields:
    description:
    - (Optional) List of comma separated fields to search on. If none are specified, all
      supported fields are implied. Fields require full path (e.g. data.attributes.name)
    - Used by I(state=['get'])
    type: str

gneSubnetName:
    description:
    - (Optional) GNE Subnet name of the TPE
    - Used by I(state=['get'])
    type: str

identifierKey:
    description:
    - (Optional) The comma separated identifier key set
    - Used by I(state=['get'])
    type: list

resourceState:
    description:
    - '(Optional) List of networkConstruct planning states. By default, if no value for
      this parameter is specified, root and unknown states are filtered out. The allowed
      values are: root, planned, discovered, plannedAndDiscovered, unknown'
    - Used by I(state=['get'])
    type: str

structureType:
    description:
    - (Optional) Comma separated list of TPE structure types
    - Used by I(state=['get'])
    type: str

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

metaDataFields:
    description:
    - '(Optional) List of meta data to be included. The allowed values are: stackDirection,
      layerRate, state, cardType, structureType, structureSubType, resourceState'
    - Used by I(state=['get'])
    type: str

identifierValue:
    description:
    - (Optional) The comma separated identifier value set
    - Used by I(state=['get'])
    type: list

bookingData.lockout:
    choices:
    - 'false'
    - 'true'
    description:
    - (Optional)  Flag that enables/disables a link from having additional tunnel BW being
      consumed
    - Used by I(state=['get'])
    type: str

networkConstruct.id:
    description:
    - (Optional) Network Construct identifier
    - 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