Try SpotterHandle resource of type nsi_api_search_tpes
| "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_search_tpes
id:
description:
- (Optional) Comma separated list of TPE identifiers to retrieve
- 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
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
content:
choices:
- detail
- summary
description:
- (Optional) The TPE content level
- Used by I(state=['get'])
type: str
include:
description:
- '(Optional) List of comma separated resources to be side-loaded. The allowed values
are: expectations, concrete, networkConstructs'
- Used by I(state=['get'])
type: str
concrete:
description:
- (Optional) Id of the concrete tpe
- Used by I(state=['get'])
type: str
location:
description:
- (Optional) TPE location delimited by dashes
- Used by I(state=['get'])
type: str
layerRate:
description:
- (optional) The layerRate. When combined with the adjacencyType queryParam, only
looks for thespecified list of adjacencyTypes within the specified layerRate.
- Used by I(state=['get'])
type: str
modelType:
description:
- (Optional) modelType parameter used to filter results
- Used by I(state=['get'])
type: str
endDateMax:
description:
- '(Optional) Maximum value of endDate, format is: yyyy-MM-dd''T''HH:mm:ss.SSSZ'
- Used by I(state=['get'])
type: str
endDateMin:
description:
- '(Optional) Minimum value of endDate, format is: yyyy-MM-dd''T''HH:mm:ss.SSSZ'
- Used by I(state=['get'])
type: str
namedQuery:
description:
- '(Optional) Comma-separated named query id list; The allowed values are: ptpEthernetNoClients,
portsEthernetAvailableAll, portsL2AvailableAll, portsL2ApplicableEPLUni, portsL2ApplicableEVPLUni,
portsL2ApplicableEnni, portsL2ApplicableEPLUniWithMcLag, portsL2ApplicableEVPLUniWithMcLag,
portsL2ApplicableEnniWithMcLag, portsTunnelsL2ApplicableAll, portsTunnelsL2ApplicableAllWithFtpIpData,
portsTDMCEApplicableAll, channelTxPorts, channelRxPorts, linePorts, matedTpes<br><br>matedTpes
cannot be used in combination with other named queries and can not be used alone,
namedQueryParam1(tpeId),namedQueryParam2(Allowed values can be CHANNEL/OTN_ACCESS)
and namedQueryParam3(Allowed values can be Working/Protect) must be provided with
this named query.'
- Used by I(state=['get'])
type: str
searchText:
description:
- (Optional) The searchable text
- Used by I(state=['get'])
type: str
equipmentId:
description:
- (Optional) Equipment identifier. In case of usage with limit parameter, paging will
be enabled.
- 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)
- Used by I(state=['get'])
type: str
startDateMax:
description:
- '(Optional) Maximum value of startDate, format is: yyyy-MM-dd''T''HH:mm:ss.SSSZ'
- Used by I(state=['get'])
type: str
startDateMin:
description:
- '(Optional) Minimum value of startDate, format is: yyyy-MM-dd''T''HH:mm:ss.SSSZ'
- Used by I(state=['get'])
type: str
adjacencyType:
description:
- (optional) The adjacencyType. When combined with the layerRate queryParam, only
looks for thespecified list of adjacencyTypes within the specified layerRate.
- Used by I(state=['get'])
type: str
gneSubnetName:
description:
- (Optional) GNE Subnet name of the TPE
- Used by I(state=['get'])
type: str
identifierKey:
description:
- Used by I(state=['get'])
type: list
resourceState:
description:
- '(Optional) List of networkConstruct 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
structureType:
description:
- (Optional) Comma separated list of TPE structure types
- Used by I(state=['get'])
type: str
locationFormat:
description:
- (Optional) Format for the given location; when not given, assume location is [[shelf-]slot-]port
- Used by I(state=['get'])
type: str
metaDataFields:
description:
- '(Optional) List of meta data to be included. The allowed values are: stackDirection,
layerRate, state, cardType, structureType, structureSubType, resourceState'
- Used by I(state=['get'])
type: str
identifierValue:
description:
- (Optional) The comma separated identifier value set
- Used by I(state=['get'])
type: list
namedQueryParam1:
description:
- First param to be used by defined namedQuery.
- Used by I(state=['get'])
type: str
namedQueryParam2:
description:
- Second param to be used by defined namedQuery.
- Used by I(state=['get'])
type: str
namedQueryParam3:
description:
- Third param to be used by defined namedQuery.
- Used by I(state=['get'])
type: str
metaDataQualifiers:
description:
- '(Optional) List of meta data options. The allowed values are: absoluteTotals'
- 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:
- (Optional) Network Construct identifier
- Used by I(state=['get'])
type: str
tpeExpectations.intent.id:
description:
- (Optional) The intent id
- Used by I(state=['get'])
type: str
tpeExpectations.intent.type:
description:
- (Optional) The intent type
- Used by I(state=['get'])
type: str
tpeExpectations.serviceIntent.id:
description:
- (Optional) The service intent Id
- Used by I(state=['get'])
type: str
tpeExpectations.equipmentIntent.id:
description:
- (Optional) The equipment intent Id
- Used by I(state=['get'])
type: str