ciena.mcp.sub_domains (1.0.4) — module

Install collection

Install with ansible-galaxy collection install ciena.mcp:==1.0.4

Add to requirements.yml

  collections:
    - name: ciena.mcp
      version: 1.0.4

Description

Handle resource of type sub_domains

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

name:
    description:
    - Name of the sub-domain
    - 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

scope:
    description:
    - Scope of the sub-domain
    - Used by I(state=['post'])
    type: str

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

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

parentId:
    description:
    - The ID of the container sub-domain, if applicable
    - 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

assignable:
    description:
    - Whether the sub-domain can be re-assigned
    - Used by I(state=['post'])
    type: bool

description:
    description:
    - Description of the sub-domain
    - Used by I(state=['post'])
    type: str

decomposable:
    description:
    - Whether the sub-domain can be decomposped
    - Used by I(state=['post'])
    type: bool

applicationSlices:
    description:
    - Set of application slices this sub-domain is in
    - Used by I(state=['post'])
    type: list

extendedApplicationSlices:
    description:
    - Set of application slices for which this sub-domain acts as an extended sub-domain
    - Used by I(state=['post'])
    type: list