ciena.mcp.nsi_api_v3_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_v3_networkconstructs

Requirements

• python >= 3.6

Inputs

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

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

state:
    choices:
    - get
    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:
    choices:
    - expectations
    - networkConstructDiscovered
    - networkConstructPlanned
    - parentNetworkConstruct
    - physicalLocation
    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

aliasName:
    description:
    - (Optional) Key that holds the subNet name
    - Used by I(state=['get'])
    type: str

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

aliasValue:
    description:
    - (Optional) List of subNet name values
    - 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.name).
      If provided, must also provide searchText parameter
    - Used by I(state=['get'])
    type: str

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

networkConstructType:
    choices:
    - networkElement
    - osrpNode
    - shelf
    description:
    - (Optional) Network Construct type
    - 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