ciena.mcp.nsi_api_networkconstructs (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_networkconstructs

Requirements

• python >= 3.6

Inputs

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

name:
    description:
    - (Optional) List of device name values
    - Used by I(state=['get'])
    type: str

limit:
    description:
    - The size of a returned page. The default is 30
    - 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

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

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

included:
    description:
    - Referenced resources (discovered, planned, expectations, physical locations, or
      parent/child Network Constructs)
    - Used by I(state=['post'])
    type: list

ipAddress:
    description:
    - (Optional) Ip Address of Network Construct
    - Used by I(state=['get'])
    type: str

sessionId:
    description:
    - (Optional) Management Session Id
    - Used by I(state=['get'])
    type: str

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

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

physicalLocationId:
    description:
    - (Optional) Physical location id
    - Used by I(state=['get'])
    type: str

networkConstructType:
    description:
    - '(Optional) Network Construct type. The allowed values are: networkElement, shelf,
      osrpNode, manual, branchingUnit, submarineRepeater'
    - Used by I(state=['get'])
    type: str

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

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