Vault SSH: Docs for default CIDR value

This commit is contained in:
vishalnayak 2015-08-27 13:10:15 -04:00
parent 5063a0608b
commit fbff20d9ab
2 changed files with 6 additions and 4 deletions

View file

@ -67,9 +67,9 @@ func pathRoles(b *backend) *framework.Path {
"cidr_list": &framework.FieldSchema{ "cidr_list": &framework.FieldSchema{
Type: framework.TypeString, Type: framework.TypeString,
Description: ` Description: `
[Required for both types] [Optional for both types]
Comma separated list of CIDR blocks for which the role is applicable for. Comma separated list of CIDR blocks for which the role is applicable for.
CIDR blocks can belong to more than one role.`, CIDR blocks can belong to more than one role. Defaults to zero-address (0.0.0.0/0)`,
}, },
"port": &framework.FieldSchema{ "port": &framework.FieldSchema{
Type: framework.TypeInt, Type: framework.TypeInt,

View file

@ -83,6 +83,8 @@ $ vault write ssh/roles/dynamic_key_role key_type=dynamic key=dev_key admin_user
Success! Data written to: ssh/roles/dynamic_key_role Success! Data written to: ssh/roles/dynamic_key_role
``` ```
Option `cidr_list` is optional and defaults to zero-address (0.0.0.0/0).
Use the `install_script` option to provide an install script if hosts does not Use the `install_script` option to provide an install script if hosts does not
resemble typical Linux machine. The default script is compiled into the binary. resemble typical Linux machine. The default script is compiled into the binary.
It is straight forward and is shown below. The script takes three arguments which It is straight forward and is shown below. The script takes three arguments which
@ -434,10 +436,10 @@ username@ip:~$
</li> </li>
<li> <li>
<span class="param">cidr_list</span> <span class="param">cidr_list</span>
<span class="param-flags">required for both types</span> <span class="param-flags">optional for both types</span>
(String) (String)
Comma separated list of CIDR blocks for which the role is applicable for. Comma separated list of CIDR blocks for which the role is applicable for.
CIDR blocks can belong to more than one role. CIDR blocks can belong to more than one role. Defaults to zero-address (0.0.0.0/0).
</li> </li>
<li> <li>
<span class="param">port</span> <span class="param">port</span>