• AnsibleFest
  • Products
  • Community
  • Webinars & Training
  • Blog
Ansible Logo
Ansible Collections Documentation
Ansible collections

Collections:

  • Collection Index
    • Collections in the Skupper Namespace
      • Skupper.Network
        • Description
        • Plugin Index

Plugin indexes:

  • Index of all Modules

Reference indexes:

  • Index of all Collection Environment Variables
Ansible collections
  • Collection Index
  • Collections in the Skupper Namespace
  • Skupper.Network
  • skupper.network.links_load module – Loads existing links to other sites

skupper.network.links_load module – Loads existing links to other sites

Note

This module is part of the skupper.network collection (version 1.1.0).

To install it, use: ansible-galaxy collection install skupper.network. You need further requirements to be able to use this module, see Requirements for details.

To use it in a playbook, specify: skupper.network.links_load.

New in skupper.network 1.1.0

  • Synopsis

  • Requirements

  • Examples

  • Return Values

Synopsis

  • Loads existing Skupper links to other sites, using the same format expected for links, referring other ansible hosts. The mapping of existing links to ansible hosts defined in the inventory file, depends on previous execution of site_load module, which loads site ids for each site defined in the inventory. Without it, links will be considered as unmapped and might be removed if links module is invoked.

Note

This module has a corresponding action plugin.

Requirements

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

  • kubectl if using kubernetes platform

  • podman v4+ if using podman as the site platform

Examples

- name: Loading existing links
  skupper.network.links_load:

Return Values

Common return values are documented here, the following are the fields unique to this module:

Key

Description

existing_links

dictionary

List of existing links mapped to the corresponding ansible inventory hostname

Returned: always

Sample: {"existing_links": [{"cost": 1, "host": "host-a", "name": "site-a"}, {"cost": 1, "host": "host-b", "name": "site-b"}]}

Collection links

Issue Tracker Homepage Repository (Sources)

Previous Next

© Copyright Ansible contributors.