Try SpotterHandle resource of type nsi_api_v4_fres
| "added in version" 1.0.0 of ciena.mcp"
Authors: unknown
Install with ansible-galaxy collection install ciena.mcp:==1.0.4
collections:
- name: ciena.mcp
version: 1.0.4Handle resource of type nsi_api_v4_fres
id:
description:
- (Optional) Comma separated list of FRE 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 FRE resource'
- ' - C(meta) (dict): A metadata object that contains non-standard meta information'
- ' - C(relationships) (dict): '
- ' - C(type) (str): The FRE 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
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
tags:
description:
- (Optional) Allow filtering on FRE tags. This parameter accepts a list of comma separated
strings
- Used by I(state=['get'])
type: str
type:
description:
- '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
- packet_infrastructure
- tdm
description:
- (Optional, Deprecated) FRE group :<ul><li>dwa for all FREs in OTU4 and all top level
FREs in ETHERNET, DSR, DSR_ETHERNET, OTSi(OCH), ODU2, ODU4, ODUCn, OTUCn<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:
- The size of a returned page
- Used by I(state=['get'])
type: str
links:
description:
- Links related to the resource
- 'Validate attributes are:'
- ' - C(current) (str): The current page of data'
- ' - C(first) (str): The first page of data'
- ' - C(last) (str): The last page of data'
- ' - C(next) (str): The next page of data'
- ' - C(prev) (str): The previous page of data'
- ' - C(self) (str): A `self` member, whose value is a URL for the relationship itself
(a "relationship URL"). This URL allows the client to directly manipulate the relationship.
For example, it would allow a client to remove an `author` from an `article` without
deleting the people resource itself.'
- Used by I(state=['post'])
type: dict
state:
choices:
- get
- post
description: []
type: str
tpeId:
description:
- TPE identifier for endpoints
- Used by I(state=['get'])
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
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:
- '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, networkConstructs, planned, freDiscovered, frePlanned'
- Used by I(state=['get'])
type: str
concrete:
description:
- (Optional) List of concrete FRE identifiers
- Used by I(state=['get'])
type: str
included:
description:
- Resources related to a FRE, such as FreData, EndPointData, TpeData, EquipmentData,
EquipmentHolderData, FrePlannedData, FreExpectationData, FreDiscoveredData, ResiliencyControllerData,
EncapsulatedResiliencyData
- Used by I(state=['post'])
type: list
layerRate:
description:
- 'FRE layer rates in comma separated list. The allowed values are: ETHERNET, OTU1,
OTU2, OTU2e, OTU3, OTU4, OTUCn, OTSi, OMS, OS, PHY, OTS, FICON, FC, ODU, ODU0, ODU1,
ODU2, ODU2e, ODU3, ODU4, ODUCn, DSR, DSR_10GE, DSR_100GE, DSR_ETHERNET, ENCAPSULATION,
MPLS, MPLS_PROTECTION, MEDIA, LAG, RS, E1, E3, E1_2M, EC1, DSR_2M, LINE_OC3_STS3_AND_MS_STM1,
SECTION_OC3_STS3_AND_RS_STM1, DSR_OC3_STM1, DSR_OC12_STM4, DSR_OC48_STM16, DSR_OC192_STM64,
CES_IWF, T1, DSR_1_5M, STS1, STS3C, STS12C, STS24C, STS48C, DS0, DS1, DS3, VT15,
VT2, NOT_APPLICABLE, ODUFLEX, OTUg, ODUg, BGP, IP'
- Used by I(state=['get'])
type: str
modelType:
description:
- (Optional) modelType parameter used to filter results
- Used by I(state=['get'])
type: str
userLabel:
description:
- User label
- Used by I(state=['get'])
type: str
adminState:
description:
- '(Optional) Allow filtering on FRE adminState. This parameter accepts a list of
comma separated values: enabled, disabled, not applicable, In Service, Out of Service'
- Used by I(state=['get'])
type: str
childFreId:
description:
- (Optional) The child FRE identifier to return its parents
- Used by I(state=['get'])
type: str
namedQuery:
description:
- '(Optional) Comma-separated named query id list; The allowed values are: resiliency,
tdmServices, topologicalLinks, roadmLineSpan'
- Used by I(state=['get'])
type: str
searchText:
description:
- (Optional) The searchable text, (default search Fields are name, layerRate, tpeLocations
if searchFields is not specified.)
- Used by I(state=['get'])
type: str
tunnelType:
description:
- '(Optional) Allow filtering on FRE Tunnel class service. This parameter accepts
a list of comma separated values: dynamic, static'
- Used by I(state=['get'])
type: str
networkRole:
choices:
- FREAP
- IFRE
- IFRECP
- ROADMLINE
description:
- (Optional) Determines if the FRE participates in an internal or external forwarding
view or involves access points or connection points
- 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
customerName:
description:
- (Optional) Search for an exact match on customerName
- Used by I(state=['get'])
type: str
searchFields:
description:
- (Optional) List of comma separated fields to search with, combined with searchText.
Fields require full path (i.e. data.attributes.field)
- Used by I(state=['get'])
type: str
serviceClass:
choices:
- EAccess
- ETransit
- EVC
- Fiber
- IP
- L3VPN
- LAG
- LLDP
- OSRP Line
- OSRP Link
- OTU
- Photonic
- ROADM Line
- SNC
- SNCP
- TDM
- Transport Client
- Tunnel
- VLAN
description:
- (Optional) Allow filtering on the FRE service class. This parameter accepts a list
of comma separated values
- Used by I(state=['get'])
type: str
coroutedFreId:
description:
- (Optional) Retrieves all correlated FREs that are co-routed and co-terminated with
the specified FRE Id
- 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
resourceState:
description:
- '(Optional) List of fre 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
sncgUserlabel:
description:
- '(Optional) For Control Plane SNCs only: Retrieves all SNCs provided the parent
SNCG userLabel'
- Used by I(state=['get'])
type: str
directionality:
choices:
- bidirectional
- unidirectional
description:
- (Optional) Indicates if unidirectional or bidirectional FREs should be returned
- Used by I(state=['get'])
type: str
lqsData.status:
choices:
- good
- high
- low
- upgrade
description:
- (Optional) Allow filtering on the LQS status. This parameter accepts a list of comma
separated values
- Used by I(state=['get'])
type: str
managementName:
description:
- Management Name
- Used by I(state=['get'])
type: str
metaDataFields:
description:
- 'MetaData to be included. The allowed values are: layerRate, layerRateQualifier,
signalContentType, serviceClass, sncgUserlabel, adminState, operationState, lqsData.status,
lqsData.margin.valid, lqsData.fiber.reconciled, lqsData.fiber.method, lqsData.margin.viableAtEol,
displayAdminState, displayOperationState, displayTopologySource, customerName'
- Used by I(state=['get'])
type: str
operationState:
description:
- '(Optional) Allow filtering on FRE operationState. This parameter accepts a list
of comma separated values: fully operating, not operating, degraded operation, Not
Applicable, Undetermined, In Service, Degraded, Out of Service External, Out of
Service'
- Used by I(state=['get'])
type: str
deploymentState:
description:
- (Optional) deploymentState parameter used to filter results
- 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
supportingFreId:
description:
- (Optional) Retrieves all supporting child FREs (one serviceClass/layer level down)
that have a serviceClass designation for the specified FRE Id
- Used by I(state=['get'])
type: str
supportedByFreId:
description:
- (Optional) Retrieves all supported parent FREs (one serviceClass/layer level up)
that have a serviceClass designation for the specified FRE Id
- Used by I(state=['get'])
type: str
displayAdminState:
description:
- (Optional) Allow filtering on FRE adminState display string
- 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
layerRateQualifier:
description:
- (Optional) Indicates additional qualification information for a LayerRate. For example,
for beyond 100G rates (e.g. OTUCn, ODUCn), defines the n multiplier, or the n-M
subrate value.
- Used by I(state=['get'])
type: str
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:
- Network Construct identifier
- Used by I(state=['get'])
type: str
lqsData.fiber.method:
choices:
- osc
- totalPower
description:
- (Optional) Allow filtering on the LQS fiber method. This parameter accepts a list
of comma separated values
- Used by I(state=['get'])
type: str
lqsData.margin.valid:
choices:
- 'false'
- 'true'
description:
- (Optional) The LQS margin validity state
- Used by I(state=['get'])
type: str
displayOperationState:
description:
- (Optional) Allow filtering on FRE operationState display string
- Used by I(state=['get'])
type: str
displayTopologySource:
description:
- (Optional) Allow filtering on FRE topologySource display string. Currently will
only be set to 'Retained' on Fres
- Used by I(state=['get'])
type: str
endpoint.tpe.concrete:
description:
- Concrete TPE identifier for endpoints
- Used by I(state=['get'])
type: str
lqsData.fiber.reconciled:
choices:
- 'false'
- 'true'
description:
- (Optional) The LQS fiber reconciled state
- Used by I(state=['get'])
type: str
lqsData.margin.viableAtEol:
description:
- (Optional) A list of LQS margin viable at EOL states
- Used by I(state=['get'])
type: str
freExpectations.serviceIntent.id:
description:
- (Optional) The service intent Id
- Used by I(state=['get'])
type: str
freExpectations.equipmentIntent.id:
description:
- (Optional) The equipment intent Id
- Used by I(state=['get'])
type: str