nttmcp.mcp.user_info (1.0.9) — module

Install collection

Install with ansible-galaxy collection install nttmcp.mcp:==1.0.9

Add to requirements.yml

  collections:
    - name: nttmcp.mcp
      version: 1.0.9

Description

Get and List the user accounts for your organization

Requirements

• requests
• configparser
• pyOpenSSL
• netaddr - configparser>=3.7.4

Usage examples

Scanned by Steampunk Spotter

• Success
  Steampunk Spotter scan finished with no errors, warnings or hints.

- hosts: 127.0.0.1
  connection: local
  collections:
    - nttmcp.mcp
  tasks:

  - name: Get your User
    user_info:
      region: na
      my_user: True

  - name: Get a specific User
    user_info:
      region: na
      username: some_username

  - name: List all user(s) with the lastname smith
    user_info:
      region: na
      lastname: smith

  - name: List all user(s) in a failed state
    user_info:
      region: na
      state: 'FAILED*'

  - name: List all user(s) with an @abc.local email address
    user_info:
      region: na
      email: '*@abc.local'

Inputs

    
auth:
    description:
    - Optional dictionary containing the authentication and API information for Cloud
      Control
    required: false
    suboptions:
      api:
        description:
        - The Cloud Control API endpoint e.g. api-na.mcp-services.net
        required: false
        type: str
      api_version:
        description:
        - The Cloud Control API version e.g. 2.11
        required: false
        type: str
      password:
        description:
        - The Cloud Control API user password
        required: false
        type: str
      username:
        description:
        - The Cloud Control API username
        required: false
        type: str
    type: dict

email:
    description:
    - The email address to search on
    - Supports using * as a wildcard
    required: false
    type: str

phone:
    description:
    - The phone number to search on
    required: false
    type: str

state:
    description:
    - The user's status
    - Supports using * as a wildcard
    required: false
    type: str

region:
    default: na
    description:
    - The geographical region
    required: false
    type: str

my_user:
    default: false
    description:
    - Return just my user information
    - This does not require a Org/Primary administrator role
    required: false
    type: bool

lastname:
    description:
    - The lastname to search on
    - Supports using * as a wildcard
    required: false
    type: str

username:
    description:
    - The username to retrieve
    required: false
    type: str

firstname:
    description:
    - The fistname to search on
    - Supports using * as a wildcard
    required: false
    type: str

department:
    description:
    - The department to search on
    - Supports using * as a wildcard
    required: false
    type: str

phone_country_code:
    description:
    - The dialing code for the country to search on
    required: false
    type: str

Outputs

data:
  contains:
    count:
      description: The number of objects returned
      returned: success
      sample: 1
      type: int
    user:
      contains:
        emailAddress:
          description: The user's email address
          sample: john.doe@abc.local
          type: str
        firstName:
          description: The user's firstname
          sample: John
          type: str
        fullName:
          description: The user's full name
          sample: John Doe
          type: str
        lastName:
          description: The user's lastname
          sample: Doe
          type: str
        organization:
          contains:
            homeGeoApiHost:
              description: The user's home Geo API host
              sample: api-na.mcp-services.net
              type: str
            homeGeoId:
              description: The home Geo ID
              sample: northamerica
              type: str
            homeGeoName:
              description: The name of the home Geo
              sample: North America
              type: str
            id:
              description: The UUID of the home Geo
              sample: b2fbd7e6-ddbb-4eb6-a2dd-ad048bc5b9ae
              type: str
            name:
              description: The organization name
              sample: myorg
              type: str
          description: Organizational level information about the user
          type: complex
        role:
          description: List of access roles associated with the user
          type: list
        state:
          description: The user's status
          sample: NORMAL
          type: str
        userName:
          description: The user ID
          sample: mysusername
          type: str
      description: User Object
      returned: success
      type: complex
  description: dict of returned Objects
  returned: success
  type: complex