/ home / menandmice / menandmice.ansible_micetro / 1.0.7 / module / claimip

menandmice.ansible_micetro.claimip (1.0.7) — module

Claim IP addresses in DHCP in the Micetro

| "added in version" 2.7 of menandmice.ansible_micetro"

Authors: Ton Kersten <t.kersten@atcomputing.nl> for Men&Mice

Install collection

Install with ansible-galaxy collection install menandmice.ansible_micetro:==1.0.7

Add to requirements.yml

  collections:
    - name: menandmice.ansible_micetro
      version: 1.0.7

Description

Claim IP addresses in DHCP in the Micetro.

These addresses can not be in a DHCP range.

Inputs

    
state:
    choices:
    - absent
    - present
    default: present
    description: The state of the claim.
    required: false
    type: bool

ipaddress:
    description: The IP address(es) to work on.
    elements: str
    required: true
    type: list

mm_provider:
    description: Definition of the Micetro API mm_provider.
    required: true
    suboptions:
      mm_password:
        description: password to login with into the API.
        no_log: true
        required: true
        type: str
      mm_url:
        description: Men&Mice API server to connect to.
        required: true
        type: str
      mm_user:
        description: userid to login with into the API.
        required: true
        type: str
    type: dict

customproperties:
    description:
    - Custom properties for the IP address.
    - These properties must already exist.
    - See also M(mm_props)
    required: false
    seealso: See also M(mm_props)
    type: dict

Outputs

message:
  description: The output message from the Men&Mice System.
  returned: always
  type: str