From 4f7c1797d1458b03362b71c3731b246b01c60edc Mon Sep 17 00:00:00 2001 From: Jeremy Schulman Date: Tue, 18 Mar 2014 16:27:50 -0400 Subject: [PATCH] Update junos_noob_config.md --- docs/junos_noob_config.md | 42 +++++++++++++++++---------------------- 1 file changed, 18 insertions(+), 24 deletions(-) diff --git a/docs/junos_noob_config.md b/docs/junos_noob_config.md index e72d68c..7c4340a 100644 --- a/docs/junos_noob_config.md +++ b/docs/junos_noob_config.md @@ -1,40 +1,34 @@ ### `junos_noob_config` +*NOTE: do not use, under construction* + ### Synopsis Install a minimal New Out of Box (NOOB) configuration that should at least set the IP-address and enable the NETCONF service. This action is performed over the device CONSOLE port using either a SERIAL-PORT or a TERMINAL-SERVER. This action will also log the device "facts" and "inventory" to a local server directory, which then provdies you with specific details about the device located on that console. Refer to [netconify](https://github.com/jeremyschulman/py-junos-netconify) for further details on this process. ### Example Usage -The following is a complete playbook illustrating the use of this action. The `TERMSERV` and `TERMSERVPORT` variables would be taken from the host inventory specific for each device. +The following is a complete playbook illustrating the use of this action. ```` ---- -- name: Junos QFX Node Device Configuration - hosts: qfx_nodes - connection: local - gather_facts: no - - logfile: /usr/local/junos/log/qfx_nodes.log - tasks: - - name: QFX {{mode}}-mode - junos_noob_qfx_node: + - name: Junos NOOB config + junos_noob_config: name={{ inventory_hostname }} - port='-t={{TERMSERV}},{{TERMSERVPORT}}' - mode=node - logfile=/usr/local/junos/noob.log - savedir=/usr/local/junos/inventory + file=/usr/local/junos/noobconf/{{inventory_hostname}}/noob.conf + port="-t={{TERMSERV}},{{TERMSERVPORT}}" + ```` +The `TERMSERV` and `TERMSERVPORT` variables would be taken from the host inventory specific for each device. ### Options -| parameter | required | default | choices | description | -|----------- |---------- |--------- |------------- |-------------------------------------------------------------------------------------------------------------------------------------------- | -| host | yes | | | This should be set to {{ inventory_hostname }} | -| user | no | $USER | | Login user-name | -| passwd | no | None | | Login password. If not supplied, assumes that ssh-keys are installed and active | -| file | yes | None | | File on the local server that contains the configuration change. | -| overrite | no | False | True, False | Determines if the `file` contents will completely replace the existing configuration (True) or a merged change (False) | -| timeout | no | 0 | | Temporarily change the NETCONF RPC timeout value. This should be set if you know the configuration change may take longer that 30 seconds | -| logfile | no | | | File on the local server when progress and status is stored | +| parameter | required | default | choices | description | +|----------- |---------- |--------- |--------- |------------------------------------------------------------------------------------------------------------------------------------------ | +| name | yes | | | This should be set to {{ inventory_hostname }} | +| port | yes | | | The port configuration per the `netconify` utility | +| user | no | root | | Login user-name | +| passwd | no | None | | Login password. *MUST* be provided if this device has already been provisioned | +| file | yes | | | Path to the Junos NOOB configuration file | +| logfile | no | | | Path to the local server file where configuration change status is logged | +| savedir | no | None | | Path to the local server directory where device facts and inventory files will be stored. Refer to the `netconify` utility for details. |