From e8f962fa7debdb8736449d497c3183c408a989bb Mon Sep 17 00:00:00 2001 From: Klaas Schoute Date: Thu, 11 Oct 2018 20:02:01 +0200 Subject: [PATCH] Update Kankun switch component configuration variable (#6682) * Update Kankun switch component configuration variable Update style of Kankun switch component documentation to follow new configuration variables description. Related to #6385. * :pencil2: Tweak --- source/_components/switch.kankun.markdown | 49 ++++++++++++++++++----- 1 file changed, 38 insertions(+), 11 deletions(-) diff --git a/source/_components/switch.kankun.markdown b/source/_components/switch.kankun.markdown index 919b798f9d1..264a6b98a45 100644 --- a/source/_components/switch.kankun.markdown +++ b/source/_components/switch.kankun.markdown @@ -30,14 +30,41 @@ switch: host: hostname_or_ipaddr ``` -Configuration variables: - -- **switches** (*Required*): The array that contains all Kankun switches. - - **identifier** (*Required*): Name of the Kankun switch as slug. Multiple entries are possible. - - **host** (*Required*): Hostname or IP address of the switch on the local network. - - **name** (*Optional*): Friendly name of the switch. - - **port** (*Optional*): HTTP connection port, defaults to 80. - - **path** (*Optional*): Path of CGI script, defaults to `/cgi-bin/json.cgi`. - - **username** (*Optional*): Username for basic authentication. - - **password** (*Optional*): Password for basic authentication. - +{% configuration %} +switches: + description: The array that contains all Kankun switches. + required: true + type: map + keys: + identifier: + description: Name of the Kankun switch as slug. Multiple entries are possible. + required: true + type: map + keys: + host: + description: Hostname or IP address of the switch on the local network. + required: true + type: string + name: + description: Friendly name of the switch. + required: false + type: string + port: + description: HTTP connection port. + required: false + default: 80 + type: integer + patch: + description: Path of CGI script. + required: false + default: "/cgi-bin/json.cgi" + type: string + username: + description: Username for basic authentication. + required: false + type: string + password: + description: Password for basic authentication. + required: false + type: string +{% endconfiguration %}