ciena.mdso.products (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 products

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

id:
    description:
    - Unique identifier of the product (ignored during create request)
    - 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

title:
    description:
    - Name or title describing the product
    - Used by I(state=['post'])
    type: str

active:
    description:
    - State of the product (active or inactive)
    - Used by I(state=['post'])
    type: bool

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

domainId:
    description:
    - Identifier of the domain that advertises the product
    - 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

constraints:
    description:
    - Additional constraints for the product
    - 'Validate attributes are:'
    - ' - C(obj) (list): '
    - Used by I(state=['post'])
    type: dict

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

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

resourceTypeId:
    description:
    - The type of resource provided by the product
    - Used by I(state=['post'])
    type: str

includeInactive:
    description:
    - If false, returns only products that are actively offered; if true, returns all
      products
    - Used by I(state=['get', 'head'])
    type: bool

providerProductId:
    description:
    - Identifier within the provider's context or scope for the product
    - Used by I(state=['post'])
    type: str