community.general.clc_modify_server (8.5.0) — module

Modify servers in CenturyLink Cloud

Authors: CLC Runner (@clc-runner)

Install collection

Install with ansible-galaxy collection install community.general:==8.5.0


Add to requirements.yml

  collections:
    - name: community.general
      version: 8.5.0

Description

An Ansible module to modify servers in CenturyLink Cloud.


Requirements

Usage examples

  • Success
    Steampunk Spotter scan finished with no errors, warnings or hints.
# Note - You must set the CLC_V2_API_USERNAME And CLC_V2_API_PASSWD Environment variables before running these examples

- name: Set the cpu count to 4 on a server
  community.general.clc_modify_server:
    server_ids:
        - UC1TESTSVR01
        - UC1TESTSVR02
    cpu: 4
    state: present
  • Success
    Steampunk Spotter scan finished with no errors, warnings or hints.
- name: Set the memory to 8GB on a server
  community.general.clc_modify_server:
    server_ids:
        - UC1TESTSVR01
        - UC1TESTSVR02
    memory: 8
    state: present
  • Success
    Steampunk Spotter scan finished with no errors, warnings or hints.
- name: Set the anti affinity policy on a server
  community.general.clc_modify_server:
    server_ids:
        - UC1TESTSVR01
        - UC1TESTSVR02
    anti_affinity_policy_name: 'aa_policy'
    state: present
  • Success
    Steampunk Spotter scan finished with no errors, warnings or hints.
- name: Remove the anti affinity policy on a server
  community.general.clc_modify_server:
    server_ids:
        - UC1TESTSVR01
        - UC1TESTSVR02
    anti_affinity_policy_name: 'aa_policy'
    state: absent
  • Success
    Steampunk Spotter scan finished with no errors, warnings or hints.
- name: Add the alert policy on a server
  community.general.clc_modify_server:
    server_ids:
        - UC1TESTSVR01
        - UC1TESTSVR02
    alert_policy_name: 'alert_policy'
    state: present
  • Success
    Steampunk Spotter scan finished with no errors, warnings or hints.
- name: Remove the alert policy on a server
  community.general.clc_modify_server:
    server_ids:
        - UC1TESTSVR01
        - UC1TESTSVR02
    alert_policy_name: 'alert_policy'
    state: absent
  • Success
    Steampunk Spotter scan finished with no errors, warnings or hints.
- name: Ret the memory to 16GB and cpu to 8 core on a lust if servers
  community.general.clc_modify_server:
    server_ids:
        - UC1TESTSVR01
        - UC1TESTSVR02
    cpu: 8
    memory: 16
    state: present

Inputs

    
cpu:
    description:
    - How many CPUs to update on the server
    type: str

wait:
    default: true
    description:
    - Whether to wait for the provisioning tasks to finish before returning.
    type: bool

state:
    choices:
    - present
    - absent
    default: present
    description:
    - The state to insure that the provided resources are in.
    type: str

memory:
    description:
    - Memory (in GB) to set to the server.
    type: str

server_ids:
    description:
    - A list of server Ids to modify.
    elements: str
    required: true
    type: list

alert_policy_id:
    description:
    - The alert policy id to be associated to the server. This is mutually exclusive with
      'alert_policy_name'
    type: str

alert_policy_name:
    description:
    - The alert policy name to be associated to the server. This is mutually exclusive
      with 'alert_policy_id'
    type: str

anti_affinity_policy_id:
    description:
    - The anti affinity policy id to be set for a hyper scale server. This is mutually
      exclusive with 'anti_affinity_policy_name'
    type: str

anti_affinity_policy_name:
    description:
    - The anti affinity policy name to be set for a hyper scale server. This is mutually
      exclusive with 'anti_affinity_policy_id'
    type: str

Outputs

server_ids:
  description: The list of server ids that are changed
  returned: success
  sample:
  - UC1TEST-SVR01
  - UC1TEST-SVR02
  type: list
servers:
  description: The list of server objects that are changed
  returned: success
  sample:
  - changeInfo:
      createdBy: service.wfad
      createdDate: 1438196820
      modifiedBy: service.wfad
      modifiedDate: 1438196820
    description: test-server
    details:
      alertPolicies: []
      cpu: 1
      customFields: []
      diskCount: 3
      disks:
      - id: 0:0
        partitionPaths: []
        sizeGB: 1
      - id: 0:1
        partitionPaths: []
        sizeGB: 2
      - id: 0:2
        partitionPaths: []
        sizeGB: 14
      hostName: ''
      inMaintenanceMode: false
      ipAddresses:
      - internal: 10.1.1.1
      memoryGB: 1
      memoryMB: 1024
      partitions: []
      powerState: started
      snapshots: []
      storageGB: 17
    groupId: 086ac1dfe0b6411989e8d1b77c4065f0
    id: test-server
    ipaddress: 10.120.45.23
    isTemplate: false
    links:
    - href: /v2/servers/wfad/test-server
      id: test-server
      rel: self
      verbs:
      - GET
      - PATCH
      - DELETE
    - href: /v2/groups/wfad/086ac1dfe0b6411989e8d1b77c4065f0
      id: 086ac1dfe0b6411989e8d1b77c4065f0
      rel: group
    - href: /v2/accounts/wfad
      id: wfad
      rel: account
    - href: /v2/billing/wfad/serverPricing/test-server
      rel: billing
    - href: /v2/servers/wfad/test-server/publicIPAddresses
      rel: publicIPAddresses
      verbs:
      - POST
    - href: /v2/servers/wfad/test-server/credentials
      rel: credentials
    - href: /v2/servers/wfad/test-server/statistics
      rel: statistics
    - href: /v2/servers/wfad/510ec21ae82d4dc89d28479753bf736a/upcomingScheduledActivities
      rel: upcomingScheduledActivities
    - href: /v2/servers/wfad/510ec21ae82d4dc89d28479753bf736a/scheduledActivities
      rel: scheduledActivities
      verbs:
      - GET
      - POST
    - href: /v2/servers/wfad/test-server/capabilities
      rel: capabilities
    - href: /v2/servers/wfad/test-server/alertPolicies
      rel: alertPolicyMappings
      verbs:
      - POST
    - href: /v2/servers/wfad/test-server/antiAffinityPolicy
      rel: antiAffinityPolicyMapping
      verbs:
      - PUT
      - DELETE
    - href: /v2/servers/wfad/test-server/cpuAutoscalePolicy
      rel: cpuAutoscalePolicyMapping
      verbs:
      - PUT
      - DELETE
    locationId: UC1
    name: test-server
    os: ubuntu14_64Bit
    osType: Ubuntu 14 64-bit
    status: active
    storageType: standard
    type: standard
  type: list