ciena / ciena.mcp / 1.0.4 / module / relationships Handle resource of type relationships | "added in version" 1.0.0 of ciena.mcp" Authors: unknownciena.mcp.relationships (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 relationships
p: description: - Optional query parameter to define a partial string match filter using property:value syntax - Used by I(state=['get', 'head']) type: str q: description: - Optional query parameter to define a query filter using property:value syntax - Used by I(state=['get', 'head']) type: str id: description: - Unique identifier for the relationship (optional/ignored on calls to create) - Used by I(state=['post']) type: str limit: description: - The maximum number of elements to return in a single paged request - Used by I(state=['get', 'head']) type: int state: choices: - get - head - post description: [] type: str offset: description: - Requested offset within the total result set to be the first element in the paged response - Used by I(state=['get', 'head']) type: int reason: description: - Reason for the orchestration state - Used by I(state=['post']) type: str sourceId: description: - UUID of source resource - Used by I(state=['post']) type: str targetId: description: - UUID of target resource - Used by I(state=['post']) type: str orchState: description: - Current state of the resource in the orchestrator - Used by I(state=['post']) type: str pageToken: description: - String pagination token returned from a previous query that encodes query information in order to optimize a - subsequent request for a page of results. The token includes the limit and offset parameters for the next page, but one or - both can be included to override the encoded values - Used by I(state=['get', 'head']) type: str properties: description: - Relationship properties - 'Validate attributes are:' - ' - C(obj) (list): ' - Used by I(state=['post']) type: dict providerData: description: - Provider custom data - 'Validate attributes are:' - ' - C(obj) (list): ' - Used by I(state=['post']) type: dict capabilityName: description: - Capability name in target resource - Used by I(state=['post']) type: str requirementName: description: - Requirement name in source resource - Used by I(state=['post']) type: str relationshipTypeId: description: - Optional query to limit relationships by the relationship type (including derived types) - Used by I(state=['get', 'head', 'post']) type: str exactRelationshipTypeId: description: - Optional query to limit relationships by an exact relationship type - Used by I(state=['get', 'head']) type: str