theforeman.foreman.compute_attribute (4.0.0) — module

Install collection

Install with ansible-galaxy collection install theforeman.foreman:==4.0.0

Add to requirements.yml

  collections:
    - name: theforeman.foreman
      version: 4.0.0

Description

Manage Compute Attributes

This beta version can create, and update compute attributes

Requirements

• requests

Usage examples

Scanned by Steampunk Spotter

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

- name: "Create compute attribute"
  theforeman.foreman.compute_attribute:
    username: "admin"
    password: "changeme"
    server_url: "https://foreman.example.com"
    compute_profile: "Test Compute Profile"
    compute_resource: "Test Compute Resource"
    vm_attrs:
      memory_mb: '2048'
      cpu: '2'
    state: present

Scanned by Steampunk Spotter

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

- name: "Update compute attribute"
  theforeman.foreman.compute_attribute:
    username: "admin"
    password: "changeme"
    server_url: "https://foreman.example.com"
    compute_profile: "Test Compute Profile"
    compute_resource: "Test Compute Resource"
    vm_attrs:
      memory_mb: '1024'
      cpu: '1'
    state: present

Inputs

    
state:
    choices:
    - present
    - absent
    default: present
    description:
    - State of the entity
    type: str

password:
    description:
    - Password of the user accessing the Foreman server.
    - If the value is not specified in the task, the value of environment variable C(FOREMAN_PASSWORD)
      will be used instead.
    required: true
    type: str

username:
    description:
    - Username accessing the Foreman server.
    - If the value is not specified in the task, the value of environment variable C(FOREMAN_USERNAME)
      will be used instead.
    required: true
    type: str

vm_attrs:
    aliases:
    - vm_attributes
    description:
    - Hash containing the data of vm_attrs
    required: false
    type: dict

server_url:
    description:
    - URL of the Foreman server.
    - If the value is not specified in the task, the value of environment variable C(FOREMAN_SERVER_URL)
      will be used instead.
    required: true
    type: str

validate_certs:
    default: true
    description:
    - Whether or not to verify the TLS certificates of the Foreman server.
    - If the value is not specified in the task, the value of environment variable C(FOREMAN_VALIDATE_CERTS)
      will be used instead.
    type: bool

compute_profile:
    description:
    - Name of compute profile
    required: true
    type: str

compute_resource:
    description:
    - Name of compute resource
    required: true
    type: str

Outputs

entity:
  contains:
    compute_attributes:
      contains:
        attributes:
          description: Effective attributes for the given combination of compute profile
            and resource.
          type: dict
        compute_profile_id:
          description: Database id of the associated compute profile.
          type: int
        compute_profile_name:
          description: Name of the associated compute profile.
          type: str
        compute_resource_id:
          description: Database id of the associated compute resource.
          type: int
        compute_resource_name:
          description: Name of the associated compute resource.
          type: str
        created_at:
          description: Creation date of the compute attribute.
          type: str
        id:
          description: Database id of the compute_attribute.
          type: int
        name:
          description: Generated friendly name for the compute attribute.
          type: str
        provider_friendly_name:
          description: Name of the provider type of the compute resource.
          type: str
        updated_at:
          description: Date of last change to the compute attribute.
          type: str
        vm_attrs:
          description: Configured attributes.
          type: dict
      description: List of compute attributes.
      elements: dict
      type: list
  description: Final state of the affected entities grouped by their type.
  returned: success
  type: dict