ciena.mcp.nsi_api_v4_equipment (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_equipment

Requirements

• python >= 3.6

Inputs

    
data:
    description:
    - The equipment data
    - 'Validate attributes are:'
    - ' - C(attributes) (dict): The equipment attributes'
    - ' - C(id) (str): The unique identifier for the equipment resource'
    - ' - C(meta) (dict): A metadata object that contains non-standard meta information'
    - ' - C(relationships) (dict): The equipment relationships'
    - ' - C(type) (str): The equipment 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

slot:
    description:
    - (Optional) Comma separated list of equipment slots
    - Used by I(state=['get'])
    type: str

limit:
    description:
    - The size of a returned page
    - Used by I(state=['get'])
    type: str

shelf:
    description:
    - (Optional) Comma separated list of equipment shelves
    - 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:
    - (Optional) Offset for current index of data to return
    - Used by I(state=['get'])
    type: str

siteId:
    description:
    - (Optional) Site Identifier for equipment
    - 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

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

subSlot:
    description:
    - (Optional) Comma separated list of equipment sub-slots
    - Used by I(state=['get'])
    type: str

cardType:
    description:
    - (Optional) List of Equipment cardType
    - Used by I(state=['get'])
    type: str

category:
    description:
    - '(Optional) List of Equipment category. The allowed values are: rack, shelf, pluggable,
      standalone'
    - Used by I(state=['get'])
    type: str

included:
    description:
    - Resources related to equipment, such as EquipmentExpectationData
    - Used by I(state=['post'])
    type: list

subShelf:
    description:
    - (Optional) Comma separated list of equipment sub-shelves
    - Used by I(state=['get'])
    type: str

searchText:
    description:
    - (Optional) The searchable text
    - 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.siteName).
      If provided, must also provide searchText parameter
    - Used by I(state=['get'])
    type: str

resourceState:
    description:
    - '(Optional) List of resource 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

metaDataFields:
    description:
    - '(Optional) List of meta data to be included. The allowed values are: specificationMismatch,
      state, availabilityState, reservationState, maintenanceMode, cardType, category,
      ncMacAddress'
    - Used by I(state=['get'])
    type: str

neContactState:
    description:
    - '(Optional) List of neContactState. The allowed values are: IN, OUT'
    - Used by I(state=['get'])
    type: str

maintenanceMode:
    description:
    - '(Optional) List of Equipment maintenanceMode. The allowed values are: true, false'
    - Used by I(state=['get'])
    type: str

reservationState:
    description:
    - '(Optional) List of Equipment reservationState. The allowed values are: Unknown,
      Not reserved, Reserved for maintenance, Reserved for facility, Reserved for reversion'
    - Used by I(state=['get'])
    type: str

availabilityState:
    description:
    - '(Optional) List of Equipment availabilityState. The allowed values are: PLANNED,
      AVAILABLE, UNVALIDATED, INUSE'
    - Used by I(state=['get'])
    type: str

networkConstruct.id:
    description:
    - (Optional) Network Construct identifier
    - Used by I(state=['get'])
    type: str

networkConstruct.name:
    description:
    - (Optional) Network Construct name
    - Used by I(state=['get'])
    type: str

specificationMismatch:
    description:
    - '(Optional) List of Equipment specificationMismatch. The allowed values are: true,
      false'
    - Used by I(state=['get'])
    type: str

networkConstruct.macAddress:
    description:
    - (Optional) Network Construct macAddress
    - Used by I(state=['get'])
    type: str

equipmentExpectations.equipmentIntent.id:
    description:
    - (Optional) Equipment Intent Identifier
    - Used by I(state=['get'])
    type: str