juniper_junos_srx_cluster

Add or remove SRX chassis cluster configuration

New in version 2.0.0.

Synopsis

  • Add an SRX chassis cluster configuration and reboot the device. Assuming the device is capable of forming an SRX cluster and has the correct cables connected, this will form an SRX cluster.
  • If an SRX chassis cluster is already present, setting cluster_enable to false will remove the SRX chassis cluster configuration and reboot the device causing the SRX cluster to be broken and the device to return to stand-alone mode.

Requirements

The following software packages must be installed on hosts that execute this module:

Module-specific Options

The following options may be specified for this module:

parameter type required default choices comments
cluster_id
int no none
The cluster ID to configure.
Required when enable is true.

aliases: cluster
enable
bool yes none
  • yes
  • no
Enable or disable cluster mode. When true cluster mode is enabled and cluster_id and node_id must also be specified. When false cluster mode is disabled and the device returns to stand-alone mode.

aliases: cluster_enable
node_id
int no none
The node ID to configure. (0 or 1)
Required when enable is true.

aliases: node

Examples

---
- name: Manipulate the SRX cluster configuration of Junos SRX devices
  hosts: junos-all
  connection: local
  gather_facts: no
  roles:
    - Juniper.junos
  tasks:
    - name: Enable an SRX cluster
      juniper_junos_srx_cluster:
        enable: true
        cluster_id: 4
        node_id: 0
      register: response
    - name: Print the response.
      debug:
        var: response.config_lines

    - name: Disable an SRX cluster
      juniper_junos_srx_cluster:
        enable: false
      register: response
    - name: Print the response.
      debug:
        var: response.config_lines

Return Values

name description returned type sample
changed
Indicates if the device's configuration has changed, or would have changed when in check mode.
success bool
failed
Indicates if the task failed.
always bool
msg
A human-readable message indicating the result.
always str
reboot
Indicates if a reboot of the device has been initiated.
success bool


Notes

Note

  • The NETCONF system service must be enabled on the target Junos device.

Author

  • Juniper Networks - Stacy Smith (@stacywsmith)

Status

This module is flagged as stableinterface which means that the maintainers for this module guarantee that no backward incompatible interface changes will be made.