From c794672ce0a8755c2be7ef1cf63153529ee0d66c Mon Sep 17 00:00:00 2001 From: Thovi Keerthi Kumar <118048345+thovikeerthi@users.noreply.github.com> Date: Thu, 5 Oct 2023 09:08:48 +0530 Subject: [PATCH 1/5] Update Command-Reference.md --- doc/Command-Reference.md | 78 +++++++++++++++++++++++++++++++++++++++- 1 file changed, 77 insertions(+), 1 deletion(-) diff --git a/doc/Command-Reference.md b/doc/Command-Reference.md index 9cb0cfbb54..ed9b39e300 100644 --- a/doc/Command-Reference.md +++ b/doc/Command-Reference.md @@ -203,11 +203,16 @@ * [Static DNS Commands](#static-dns-commands) * [Static DNS config command](#static-dns-config-command) * [Static DNS show command](#static-dns-show-command) - +* [PAC Commands](#pac-commands) + * [pac config command](#pac-config-command) + * [pac show command](#pac-show-command) + * [hostapd config command](#hostapd-config-command) + * [hostapd show command](#hostapd-show-command) ## Document History | Version | Modification Date | Details | | --- | --- | --- | +| v8 | Sep-10-2023 | Add PAC show and config commands | | v7 | Jun-22-2023 | Add static DNS show and config commands | | v6 | May-06-2021 | Add SNMP show and config commands | | v5 | Nov-05-2020 | Add document for console commands | @@ -12802,6 +12807,77 @@ Options: -h, -?, --help Show this message and exit. ``` +## Static DNS show command + +- Show static DNS configuration + +``` +admin@sonic:~$ show dns nameserver -h +Usage: show dns nameserver [OPTIONS] + + Show static DNS configuration + +Options: + -h, -?, --help Show this message and exit. +``` +``` +admin@sonic:~$ show dns nameserver + Nameserver +------------ + 1.1.1.1 + 8.8.8.8 + +``` + +# PAC (Port Access Control) Commands + +This sub-section explains the list of the configuration options available for PAC (Port Access Control) feature. In this context, PAC commands specific to dot1_x and MAB authentication functionality are provided. + +## PAC Global config command + +- Configure PAC authentication order in system + +``` +admin@sonic:~$ config pac-config global auth-order-list -h +Usage: + +Options: + -?, -h, --help Show this message and exit. +``` + +## MAB User/Client config commands + +- Add MAB Client specific configuration + +``` +admin@sonic:~$ config mab-user-config add -h +Usage: + +Options: + -h, -?, --help Show this message and exit. +``` + +- Delete MAB Client specific configuration + +``` +admin@sonic:~$ config mab-user-config del -h +Usage: + +Options: + -h, -?, --help Show this message and exit. +``` + +- Update MAB Client specific configuration + +``` +admin@sonic:~$ config mab-user-config update -h +Usage: + +Options: + -h, -?, --help Show this message and exit. +``` + + ## Static DNS show command - Show static DNS configuration From 5700963ec5bee49e64223507610acd37af1f447d Mon Sep 17 00:00:00 2001 From: Thovi Keerthi Kumar <118048345+thovikeerthi@users.noreply.github.com> Date: Thu, 5 Oct 2023 09:44:01 +0530 Subject: [PATCH 2/5] Update Command-Reference.md --- doc/Command-Reference.md | 80 ++++++++++++++++++++++++++++++++-------- 1 file changed, 64 insertions(+), 16 deletions(-) diff --git a/doc/Command-Reference.md b/doc/Command-Reference.md index ed9b39e300..3cd3534a6d 100644 --- a/doc/Command-Reference.md +++ b/doc/Command-Reference.md @@ -205,9 +205,12 @@ * [Static DNS show command](#static-dns-show-command) * [PAC Commands](#pac-commands) * [pac config command](#pac-config-command) + * [MAB user config commands](#mab-user-config-commands) + * [Hostapd dot1_x user config commands](#hostapd-dot1_x-user-config-commands) * [pac show command](#pac-show-command) - * [hostapd config command](#hostapd-config-command) - * [hostapd show command](#hostapd-show-command) + * [MAB user show command](#mab-user-show-command) + * [Hostapd dot1_x user show command](#hostapd-dot1_x-user-show-command) + ## Document History | Version | Modification Date | Details | @@ -12845,9 +12848,9 @@ Options: -?, -h, --help Show this message and exit. ``` -## MAB User/Client config commands +## MAB User config commands -- Add MAB Client specific configuration +- Add MAB user specific configuration ``` admin@sonic:~$ config mab-user-config add -h @@ -12857,7 +12860,7 @@ Options: -h, -?, --help Show this message and exit. ``` -- Delete MAB Client specific configuration +- Delete MAB user specific configuration ``` admin@sonic:~$ config mab-user-config del -h @@ -12867,7 +12870,7 @@ Options: -h, -?, --help Show this message and exit. ``` -- Update MAB Client specific configuration +- Update MAB user specific configuration ``` admin@sonic:~$ config mab-user-config update -h @@ -12877,25 +12880,70 @@ Options: -h, -?, --help Show this message and exit. ``` +## Hostapd Dot1_x User config commands -## Static DNS show command +- Add Hostapd dot1_x user specific configuration -- Show static DNS configuration +``` +admin@sonic:~$ config hostapd-user-config add -h +Usage: +Options: + -h, -?, --help Show this message and exit. ``` -admin@sonic:~$ show dns nameserver -h -Usage: show dns nameserver [OPTIONS] - Show static DNS configuration +- Delete Hostapd dot1_x user specific configuration + +``` +admin@sonic:~$ config hostapd-user-config delete -h +Usage: Options: -h, -?, --help Show this message and exit. ``` + +- Update Hostapd dot1_x Client specific configuration + +``` +admin@sonic:~$ config hostapd-user-config update -h +Usage: + +Options: + -h, -?, --help Show this message and exit. ``` -admin@sonic:~$ show dns nameserver - Nameserver ------------- - 1.1.1.1 - 8.8.8.8 + +## PAC show command + +- Show PAC global configuration ``` +admin@sonic:~$ show pac-config global -h +Usage: + +Options: + -h, -?, --help Show this message and exit. + + +## MAB User show command + +- Show MAB User configuration + +``` +admin@sonic:~$ show mab-user-config -h +Usage: + +Options: + -h, -?, --help Show this message and exit. + +## Hostapd dot1_x User show command + +- Show Hostapd dot1_x User configuration + +``` +admin@sonic:~$ how hostapd-user-config -h +Usage: + +Options: + -h, -?, --help Show this message and exit. + + From e033238eb4bb18c904937d810672246c8daf834e Mon Sep 17 00:00:00 2001 From: Thovi Keerthi Kumar <118048345+thovikeerthi@users.noreply.github.com> Date: Thu, 5 Oct 2023 09:53:12 +0530 Subject: [PATCH 3/5] Update Command-Reference.md --- doc/Command-Reference.md | 4 ++-- 1 file changed, 2 insertions(+), 2 deletions(-) diff --git a/doc/Command-Reference.md b/doc/Command-Reference.md index 3cd3534a6d..d2b0640476 100644 --- a/doc/Command-Reference.md +++ b/doc/Command-Reference.md @@ -12834,7 +12834,7 @@ admin@sonic:~$ show dns nameserver # PAC (Port Access Control) Commands -This sub-section explains the list of the configuration options available for PAC (Port Access Control) feature. In this context, PAC commands specific to dot1_x and MAB authentication functionality are provided. +This sub-section explains the list of the configuration options available for PAC (Port Access Control) feature. In this context, PAC commands specific to dot1_x and MAB authentication functionality are provided. These CLI Commands will be autogenerated using PAC Yang files. ## PAC Global config command @@ -12940,7 +12940,7 @@ Options: - Show Hostapd dot1_x User configuration ``` -admin@sonic:~$ how hostapd-user-config -h +admin@sonic:~$ show hostapd-user-config -h Usage: Options: From c3c58cc63c59020d6893c7cdef6b10e71dc0ebd7 Mon Sep 17 00:00:00 2001 From: Thovi Keerthi Kumar <118048345+thovikeerthi@users.noreply.github.com> Date: Thu, 5 Oct 2023 14:40:17 +0530 Subject: [PATCH 4/5] Update Command-Reference.md --- doc/Command-Reference.md | 54 ++++++++++++++++++++++++++++++---------- 1 file changed, 41 insertions(+), 13 deletions(-) diff --git a/doc/Command-Reference.md b/doc/Command-Reference.md index d2b0640476..3492943467 100644 --- a/doc/Command-Reference.md +++ b/doc/Command-Reference.md @@ -12842,7 +12842,10 @@ This sub-section explains the list of the configuration options available for PA ``` admin@sonic:~$ config pac-config global auth-order-list -h -Usage: +Usage: config pac-config global auth-order-list [OPTIONS] AUTH_ORDER_LIST + + Order list of authentication mechanisms used by PAC. Must be 'remote' or + 'local'. Options: -?, -h, --help Show this message and exit. @@ -12854,30 +12857,41 @@ Options: ``` admin@sonic:~$ config mab-user-config add -h -Usage: +Usage: config mab-user-config add [OPTIONS] MAC + + Add object in MAB_USER_CONFIG. Options: - -h, -?, --help Show this message and exit. + --access-type TEXT Access type for the MAB client (allow or deny) + --vlan-id TEXT VLAN ID associated with the authorized client + --session-timeout TEXT Client session timeout in seconds + -h, -?, --help Show this message and exit. ``` - Delete MAB user specific configuration ``` -admin@sonic:~$ config mab-user-config del -h -Usage: +Usage: config mab-user-config delete [OPTIONS] MAC + + Delete object in MAB_USER_CONFIG. Options: - -h, -?, --help Show this message and exit. + -?, -h, --help Show this message and exit. ``` - Update MAB user specific configuration ``` admin@sonic:~$ config mab-user-config update -h -Usage: +Usage: config mab-user-config update [OPTIONS] MAC + + Add object in MAB_USER_CONFIG. Options: - -h, -?, --help Show this message and exit. + --access-type TEXT Access type for the MAB client (allow or deny) + --vlan-id TEXT VLAN ID associated with the authorized client + --session-timeout TEXT Client session timeout in seconds + -h, -?, --help Show this message and exit. ``` ## Hostapd Dot1_x User config commands @@ -12886,17 +12900,25 @@ Options: ``` admin@sonic:~$ config hostapd-user-config add -h -Usage: +Usage: config hostapd-user-config add [OPTIONS] USERNAME + + Add object in HOSTAPD_USER_CONFIG. Options: - -h, -?, --help Show this message and exit. + --password TEXT Password of the user + --auth-type TEXT + --vlan-id TEXT VLAN ID associated with the authorized client + --session-timeout TEXT Client session timeout in seconds + -?, -h, --help Show this message and exit. ``` - Delete Hostapd dot1_x user specific configuration ``` admin@sonic:~$ config hostapd-user-config delete -h -Usage: +Usage: config hostapd-user-config delete [OPTIONS] USERNAME + + Delete object in HOSTAPD_USER_CONFIG. Options: -h, -?, --help Show this message and exit. @@ -12906,10 +12928,16 @@ Options: ``` admin@sonic:~$ config hostapd-user-config update -h -Usage: +Usage: config hostapd-user-config update [OPTIONS] USERNAME + + Add object in HOSTAPD_USER_CONFIG. Options: - -h, -?, --help Show this message and exit. + --password TEXT Password of the user + --auth-type TEXT + --vlan-id TEXT VLAN ID associated with the authorized client + --session-timeout TEXT Client session timeout in seconds + -h, -?, --help Show this message and exit. ``` ## PAC show command From 57468ba0bb4c5a2c1e1140f6f433378f4f9fd028 Mon Sep 17 00:00:00 2001 From: Thovi Keerthi Kumar <118048345+thovikeerthi@users.noreply.github.com> Date: Thu, 5 Oct 2023 15:11:00 +0530 Subject: [PATCH 5/5] Update Command-Reference.md --- doc/Command-Reference.md | 49 +++++++++++++++++++++++----------------- 1 file changed, 28 insertions(+), 21 deletions(-) diff --git a/doc/Command-Reference.md b/doc/Command-Reference.md index 3492943467..8eb9cbd746 100644 --- a/doc/Command-Reference.md +++ b/doc/Command-Reference.md @@ -203,13 +203,13 @@ * [Static DNS Commands](#static-dns-commands) * [Static DNS config command](#static-dns-config-command) * [Static DNS show command](#static-dns-show-command) -* [PAC Commands](#pac-commands) - * [pac config command](#pac-config-command) +* [Port Access Control Commands](#port-access-control-commands) + * [PAC config command](#pac-config-command) * [MAB user config commands](#mab-user-config-commands) - * [Hostapd dot1_x user config commands](#hostapd-dot1_x-user-config-commands) - * [pac show command](#pac-show-command) + * [Hostapd user config commands](#hostapd-user-config-commands) + * [PAC show command](#pac-show-command) * [MAB user show command](#mab-user-show-command) - * [Hostapd dot1_x user show command](#hostapd-dot1_x-user-show-command) + * [Hostapd user show command](#hostapd-user-show-command) ## Document History @@ -12832,11 +12832,11 @@ admin@sonic:~$ show dns nameserver ``` -# PAC (Port Access Control) Commands +# Port Access Control Commands -This sub-section explains the list of the configuration options available for PAC (Port Access Control) feature. In this context, PAC commands specific to dot1_x and MAB authentication functionality are provided. These CLI Commands will be autogenerated using PAC Yang files. +This sub-section explains the list of the configuration options available for PAC (Port Access Control) feature. These CLI Commands shall be autogenerated using PAC Yang files. -## PAC Global config command +## PAC config command - Configure PAC authentication order in system @@ -12894,9 +12894,9 @@ Options: -h, -?, --help Show this message and exit. ``` -## Hostapd Dot1_x User config commands +## Hostapd User config commands -- Add Hostapd dot1_x user specific configuration +- Add Hostapd user specific configuration ``` admin@sonic:~$ config hostapd-user-config add -h @@ -12912,7 +12912,7 @@ Options: -?, -h, --help Show this message and exit. ``` -- Delete Hostapd dot1_x user specific configuration +- Delete Hostapd user specific configuration ``` admin@sonic:~$ config hostapd-user-config delete -h @@ -12924,7 +12924,7 @@ Options: -h, -?, --help Show this message and exit. ``` -- Update Hostapd dot1_x Client specific configuration +- Update Hostapd user specific configuration ``` admin@sonic:~$ config hostapd-user-config update -h @@ -12946,11 +12946,13 @@ Options: ``` admin@sonic:~$ show pac-config global -h -Usage: +Usage: show pac-config global [OPTIONS] -Options: - -h, -?, --help Show this message and exit. + Global PAC configuration. +Options: + -?, -h, --help Show this message and exit. +``` ## MAB User show command @@ -12958,20 +12960,25 @@ Options: ``` admin@sonic:~$ show mab-user-config -h -Usage: +Usage: show mab-user-config [OPTIONS] COMMAND [ARGS]... + + MAB client configuration [Callable command group] Options: - -h, -?, --help Show this message and exit. + -?, -h, --help Show this message and exit. +``` -## Hostapd dot1_x User show command +## Hostapd User show command -- Show Hostapd dot1_x User configuration +- Show Hostapd User configuration ``` admin@sonic:~$ show hostapd-user-config -h -Usage: +Usage: show hostapd-user-config [OPTIONS] COMMAND [ARGS]... + + User configuration for HOSTAPD [Callable command group] Options: -h, -?, --help Show this message and exit. - +```