ciena.mdso.resources (1.1.6) — module

Install collection

Install with ansible-galaxy collection install ciena.mdso:==1.1.6

Add to requirements.yml

  collections:
    - name: ciena.mdso
      version: 1.1.6

Description

Handle resource of type resources

Requirements

• python >= 3.6

Inputs

    
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

tags:
    description:
    - Optional query parameter to define a tag filter. May use whitespace-separated AND/OR
      query (e.g. (one:1) OR (two:2) AND (three:3)) syntax or tagKey:tagValue syntax
    - Used by I(state=['get', 'head', 'post'])
    type: str

label:
    description:
    - Textual label
    - 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

shared:
    description:
    - Is resource shared?
    - Used by I(state=['post'])
    type: bool

orderId:
    description:
    - If applicable, the order containing this resource
    - Used by I(state=['post'])
    type: str

domainId:
    description:
    - Optional query to limit resources by domain
    - Used by I(state=['get', 'head'])
    type: str

validate:
    description:
    - Whether to perform custom validation in addition to built-in schema and accessor
      validations
    - Used by I(state=['post'])
    type: bool

autoClean:
    description:
    - Free up any resources automatically upon any activation failure
    - Used by I(state=['post'])
    type: bool

obfuscate:
    description:
    - If true, schema obfuscated values will be replaced with a fixed string in the response.
    - Used by I(state=['get', 'head', 'post'])
    type: bool

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

productId:
    description:
    - Optional query to limit resources by product type
    - Used by I(state=['get', 'head', 'post'])
    type: str

discovered:
    description:
    - Is this resource discovered
    - Used by I(state=['post'])
    type: bool

properties:
    description:
    - Properties
    - 'Validate attributes are:'
    - ' - C(obj) (list): '
    - Used by I(state=['post'])
    type: dict

description:
    description:
    - Detailed description of this resource
    - Used by I(state=['post'])
    type: str

exactTypeId:
    description:
    - Optional query to limit resources by one or more exact resource types (takes precedence
      over resourceTypeId). Use a comma-separated string to specify multiple resource
      types.
    - Used by I(state=['get', 'head'])
    type: str

nativeState:
    description:
    - Native (type specific) state
    - Used by I(state=['post'])
    type: str

subDomainId:
    description:
    - Optional query to limit resources by one or more subdomain ids. Use a comma-separated
      string to specify multiple subdomain ids.
    - Used by I(state=['get', 'head', 'post'])
    type: str

providerData:
    description:
    - Provider custom data
    - 'Validate attributes are:'
    - ' - C(obj) (list): '
    - Used by I(state=['post'])
    type: dict

resourceTypeId:
    description:
    - Optional query to limit resources by one or more resource types. Use a comma-separated
      string to specify multiple resource types.
    - Used by I(state=['get', 'head'])
    type: str

desiredOrchState:
    description:
    - Desired orchestration state
    - Used by I(state=['post'])
    type: str

applicationSliceId:
    description:
    - Optional query to limit resources by the application slice id.
    - Used by I(state=['get', 'head'])
    type: str

providerResourceId:
    description:
    - Optional query to identify resource by provider resource ID
    - Used by I(state=['get', 'head', 'post'])
    type: str

resourceProviderId:
    description:
    - Optional query to limit resources by resource provider
    - Used by I(state=['get', 'head'])
    type: str

sharingPermissionId:
    description:
    - The sharing permission of the resource
    - Used by I(state=['post'])
    type: str