codeaffen.phpipam.tag (1.7.0) — module

Manage tags

| "added in version" 1.4.0 of codeaffen.phpipam"

Authors: Christian Meißner (@cmeissner)

Install collection

Install with ansible-galaxy collection install codeaffen.phpipam:==1.7.0


Add to requirements.yml

  collections:
    - name: codeaffen.phpipam
      version: 1.7.0

Description

create, update and delete tags


Requirements

Usage examples

  • Success
    Steampunk Spotter scan finished with no errors, warnings or hints.
- name: "Create tag"
  codeaffen.phpipam.tag:
    username: "admin"
    password: "s3cr3t"
    server_url: "https://ipam.example.com"
    name: "my tag"
    bg_color: #ffffff
    fg_color: #000000
    state: present
  • Success
    Steampunk Spotter scan finished with no errors, warnings or hints.
- name: "Remove tag"
  codeaffen.phpipam.tag:
    username: "admin"
    password: "s3cr3t"
    server_url: "https://ipam.example.com"
    name: "my tag"
    state: absent

Inputs

    
name:
    aliases:
    - type
    description: Name of the given tag
    required: true
    type: str

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

app_id:
    default: ansible
    description: API app name
    required: false
    type: str

bg_color:
    description:
    - Background color of the given tag
    - Can be a valid color name or a hex code
    required: true
    type: str

fg_color:
    description:
    - Foreground color of the given tag
    - Can be a valid color name or a hex code
    required: true
    type: str

password:
    description: Password of the user to access phpIPAM server
    required: true
    type: str

show_tag:
    default: false
    description: Show tag or not
    required: false
    type: bool

username:
    description: Username to access phpIPAM server
    required: true
    type: str

is_locked:
    default: false
    description: Lock tag or not
    required: false
    type: bool

server_url:
    description: URL of the phpIPAM server
    required: true
    type: str

update_tags:
    default: false
    description: Update tags or not
    required: false
    type: bool

compress_range:
    default: false
    description: Compress range or not
    required: false
    type: bool

validate_certs:
    default: true
    description: Is the TLS certificate of the phpIPAM server verified or not.
    required: false
    type: bool