ciena.mcp.nsi_api_v3_fres (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_fres

Requirements

• python >= 3.6

Inputs

    
srlg:
    description:
    - (Optional) Find roadmlines by srlg values separated by comma. A roadmline is a FRE
      between two SAM cards.
    - Used by I(state=['get'])
    type: str

type:
    description:
    - '(Optional) FRE types in comma separated list. The allowed values are: service,
      link, roadmline-ap, roadmline'
    - Used by I(state=['get'])
    type: str

group:
    choices:
    - dwa
    - infrastructure
    - packet
    description:
    - FRE group :<ul><li>dwa for all FREs in OTU4 and all top level FREs in ETHERNET,
      DSR, DSR_ETHERNET, OTSi(OCH), ODU2, ODU4<li>infrastructure for all FRE-APs representing
      forwarding constructs between ROADM OTS'<li>packet for all L2 nodal and top level
      FREs in ETHERNET including infrastructure</ul>
    - Used by I(state=['get'])
    type: str

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

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

tpeId:
    description:
    - TPE identifier for endpoints
    - 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:
    - (Optional) Offset for the second page
    - Used by I(state=['get'])
    type: str

exclude:
    choices:
    - actual
    - expectation
    description:
    - (Optional) The given type would be excluded from get parents call, only combine
      with childFreId
    - Used by I(state=['get'])
    type: str

freType:
    description:
    - '(Optional) FRE types in comma separated list. The allowed values are: explicitRoute,
      explicitRouteGroup, snc, sncGroup'
    - Used by I(state=['get'])
    type: str

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

layerRate:
    description:
    - '(Optional) FRE layer rates in comma separated list. The allowed values are: ETHERNET,
      OTU2, OTU4, OTSi, OMS, OS, PHY, OTS, ODU2, ODU4, DSR, DSR_10GE, DSR_100GE, DSR_ETHERNET'
    - Used by I(state=['get'])
    type: str

userLabel:
    description:
    - (Optional) User label
    - Used by I(state=['get'])
    type: str

childFreId:
    description:
    - The child FRE identifier to return its parents
    - Used by I(state=['get'])
    type: str

searchText:
    description:
    - (Optional) The searchable text
    - Used by I(state=['get'])
    type: str

roadmLineId:
    description:
    - (Optional) Find services configured over a roadmline based on the roadmline FRE
      identifier.
    - Used by I(state=['get'])
    type: str

identifierKey:
    description:
    - List of comma separated keys for an identifer object
    - Used by I(state=['get'])
    type: list

managementName:
    description:
    - (Optional) Management Name
    - Used by I(state=['get'])
    type: str

identifierValue:
    description:
    - List of comma separated values for an identifier object
    - Used by I(state=['get'])
    type: list

includeMetaData:
    description:
    - '(Optional) MetaData to be included. The allowed values are: layerRate'
    - Used by I(state=['get'])
    type: str

signalContentType:
    description:
    - (Optional) The identifier indicating type of parent to be returned. If specified,
      parent matching the criteria will be returned
    - Used by I(state=['get'])
    type: str

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

endpoint.tpe.concrete:
    description:
    - Concrete TPE identifier for endpoints
    - Used by I(state=['get'])
    type: str

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

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