aos_logical_device_map – Manage AOS Logical Device Map

New in version 2.3.

DEPRECATED

Removed in Ansible:  version: 2.9 Why:This module does not support AOS 2.1 or later Alternative:See new modules at https://www.ansible.com/ansible-apstra.

Synopsis

• Apstra AOS Logical Device Map module let you manage your Logical Device Map easily. You can create create and delete Logical Device Map by Name, ID or by using a JSON File. This module is idempotent and support the check mode. It’s using the AOS REST API.

Requirements

The below requirements are needed on the host that executes this module.

• aos-pyez >= 0.6.0

Parameters

Parameter	Choices/Defaults	Comments
content -		Datastructure of the Logical Device Map to manage. The data can be in YAML / JSON or directly a variable. It's the same datastructure that is returned on success in value. Only one of name, id or content can be set.
id -		AOS Id of the Logical Device Map to manage (can't be used to create a new Logical Device Map), Only one of name, id or content can be set.
name -		Name of the Logical Device Map to manage. Only one of name, id or content can be set.
session - / required		An existing AOS session as obtained by aos_login module.
state -	Choices: present ← absent	Indicate what is the expected state of the Logical Device Map (present or not).

Examples

- name: "Create an Logical Device Map with one subnet"
  aos_logical_device_map:
    session: "{{ aos_session }}"
    name: "my-logical-device-map"
    state: present

- name: "Create an Logical Device Map with multiple subnets"
  aos_logical_device_map:
    session: "{{ aos_session }}"
    name: "my-other-logical-device-map"
    state: present

- name: "Check if an Logical Device Map exist with same subnets by ID"
  aos_logical_device_map:
    session: "{{ aos_session }}"
    name: "45ab26fc-c2ed-4307-b330-0870488fa13e"
    state: present

- name: "Delete an Logical Device Map by name"
  aos_logical_device_map:
    session: "{{ aos_session }}"
    name: "my-logical-device-map"
    state: absent

- name: "Delete an Logical Device Map by id"
  aos_logical_device_map:
    session: "{{ aos_session }}"
    id: "45ab26fc-c2ed-4307-b330-0870488fa13e"
    state: absent

# Save an Logical Device Map to a file

- name: "Access Logical Device Map 1/3"
  aos_logical_device_map:
    session: "{{ aos_session }}"
    name: "my-logical-device-map"
    state: present
  register: logical_device_map

- name: "Save Logical Device Map into a file in JSON 2/3"
  copy:
    content: "{{ logical_device_map.value | to_nice_json }}"
    dest: logical_device_map_saved.json

- name: "Save Logical Device Map into a file in YAML 3/3"
  copy:
    content: "{{ logical_device_map.value | to_nice_yaml }}"
    dest: logical_device_map_saved.yaml

- name: "Load Logical Device Map from a JSON file"
  aos_logical_device_map:
    session: "{{ aos_session }}"
    content: "{{ lookup('file', 'resources/logical_device_map_saved.json') }}"
    state: present

- name: "Load Logical Device Map from a YAML file"
  aos_logical_device_map:
    session: "{{ aos_session }}"
    content: "{{ lookup('file', 'resources/logical_device_map_saved.yaml') }}"
    state: present

Status

• This module will be removed in version 2.9. [deprecated]
• For more information see DEPRECATED.

Authors

• Damien Garros (@dgarros)

Hint

If you notice any issues in this documentation you can edit this document to improve it.