ciena / ciena.mcp / 1.0.4 / module / nsi_api_fres Handle resource of type nsi_api_fres | "added in version" 1.0.0 of ciena.mcp" Authors: unknownciena.mcp.nsi_api_fres (1.0.4) — module
Install with ansible-galaxy collection install ciena.mcp:==1.0.4
collections: - name: ciena.mcp version: 1.0.4
Handle resource of type nsi_api_fres
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 limit: description: - (Optional) The size of a returned page. The default is 30 - 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 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: description: - '(Optional) A single given type to be excluded used in conjunction with the `childFreId` parameter. The allowed values are: actual, expectation' - 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, frePlanned, freDiscovered' - 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: - '(Optional) FRE layer rates in comma separated list. Only applied when Network Construct identifier is provided. 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 childFreId: description: - The child FRE identifier to return its parents - 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 identifierValue: description: - List of comma separated values for an identifier object - Used by I(state=['get']) type: list 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.intent.id: description: - The intent Id - 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