.. _junos_srx_cluster:


junos_srx_cluster - Create an srx chassis cluster for cluster capable srx running Junos OS.
+++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++

:Author: Patrik Bok, Ashley Burston, Rick Sherman, Juniper Networks

.. contents::
   :local:
   :depth: 1

Synopsis
--------

.. versionadded:: 1.2.0

Create an srx chassis cluster and reboot the device. The device must be capable of forming an srx cluster and have the correct cables installed.

Options
-------

.. raw:: html

    <table border=1 cellpadding=4>
    <tr>
    <th class="head">parameter</th>
    <th class="head">required</th>
    <th class="head">default</th>
    <th class="head">choices</th>
    <th class="head">comments</th>
    </tr>
            <tr>
    <td>cluster_enable</td>
    <td>yes</td>
    <td></td>
        <td><ul><li>true</li><li>false</li><li>yes</li><li>no</li></ul></td>
        <td>yes/true - set device to cluster mode (specify cluster_id and node)no/false - set device to stand alone mode (disable cluster mode)</td>
    </tr>
            <tr>
    <td>cluster_id</td>
    <td>no</td>
    <td>None</td>
        <td><ul></ul></td>
        <td>set to the cluster id , required for cluster_enable=YES</td>
    </tr>
            <tr>
    <td>console</td>
    <td>no</td>
    <td>None</td>
        <td><ul></ul></td>
        <td>SERIAL or TERMINAL-SERVER port setting, per use with the <b>netconify</b> utility</td>
    </tr>
            <tr>
    <td>host</td>
    <td>yes</td>
    <td></td>
        <td><ul></ul></td>
        <td>Set to {{ inventory_hostname }}</td>
    </tr>
            <tr>
    <td>logfile</td>
    <td>no</td>
    <td>None</td>
        <td><ul></ul></td>
        <td>Path on the local server where the progress status is logged for debugging purposes</td>
    </tr>
            <tr>
    <td>mode</td>
    <td>no</td>
    <td>None</td>
        <td><ul></ul></td>
        <td>mode of console connection (telnet/serial). If mode is not provided SSH connection is used.</td>
    </tr>
            <tr>
    <td>node</td>
    <td>no</td>
    <td>None</td>
        <td><ul></ul></td>
        <td>set to the node required (0 or 1)</td>
    </tr>
            <tr>
    <td>passwd</td>
    <td>no</td>
    <td>assumes ssh-key active</td>
        <td><ul></ul></td>
        <td>Login password</td>
    </tr>
            <tr>
    <td>port</td>
    <td>no</td>
    <td>830</td>
        <td><ul></ul></td>
        <td>port number to use when connecting to the device</td>
    </tr>
            <tr>
    <td>ssh_private_key_file</td>
    <td>no</td>
    <td>None</td>
        <td><ul></ul></td>
        <td>This can be used if you need to provide a private key rather than loading the key into the ssh-key-ring/environment.  if your ssh-key requires a password, then you must provide it via **passwd**</td>
    </tr>
            <tr>
    <td>user</td>
    <td>no</td>
    <td>$USER</td>
        <td><ul></ul></td>
        <td>Login username</td>
    </tr>
        </table>


.. note:: Requires junos-eznc >= 1.2.2


Examples
--------

.. raw:: html

    <br/>


::

    
    -junos_srx_cluster:
      host={{ inventory_hostname }}
      console="--port={{ serial }}"
      user=rick
      passwd=password123
      cluster_enable=true
      logfile=cluster.log
      cluster_id={{ cluster_id }}
      node={{ node_id }}
    
    -junos_srx_cluster:
      host={{ inventory_hostname }}
      user=rick
      passwd=password123
      cluster_enable=false
      logfile=cluster.log
    
    # over console server connection using PyEZ >= 2.0
    -junos_srx_cluster:
      host={{ inventory_hostname }}
      user=rick
      passwd=password123
      mode="telnet"
      port=7032
      cluster_enable=true
      logfile=cluster.log