summaryrefslogtreecommitdiff
path: root/interface-definitions/include
diff options
context:
space:
mode:
authorJamie Austin <jamiea@opusv.com.au>2023-02-02 09:56:48 +1100
committerJamie Austin <jamiea@opusv.com.au>2023-02-02 09:56:48 +1100
commit80d83f6392ceac3907a9c23c6525c984e5808b4d (patch)
treef6899a8f65a8988e4a7ed7068f97d6b5dcf00059 /interface-definitions/include
parent70794c8266ffefc6660daac3bc8a63b412d7b350 (diff)
downloadvyos-1x-80d83f6392ceac3907a9c23c6525c984e5808b4d.tar.gz
vyos-1x-80d83f6392ceac3907a9c23c6525c984e5808b4d.zip
ocserv: T3896: CLI help and description rewording
Diffstat (limited to 'interface-definitions/include')
-rw-r--r--interface-definitions/include/openconnect-config-per-x.xml.i14
1 files changed, 7 insertions, 7 deletions
diff --git a/interface-definitions/include/openconnect-config-per-x.xml.i b/interface-definitions/include/openconnect-config-per-x.xml.i
index 71bbdd68f..c9b200249 100644
--- a/interface-definitions/include/openconnect-config-per-x.xml.i
+++ b/interface-definitions/include/openconnect-config-per-x.xml.i
@@ -1,24 +1,24 @@
<!-- include start from openconnect-config-per-x.xml.i -->
<node name="config-per-x">
<properties>
- <help>Configures ocserv to search the configured directory for a config file matching the Group name or username</help>
+ <help>Configures OpenConnect to search the configured directory for a config file matching the Group name or Username</help>
</properties>
<children>
<leafNode name="mode">
<properties>
- <help>ocserv will ignore these configs if groupconfig is enabled TODO: explain this in better detail - need to make it clear this is in reference to the groupconfig vyos config that lives up one level from here</help>
+ <help>Configures OpenConnect to use config-per-group or config-per-user. Ignored if OpenConnect authentication group is configured.</help>
<valueHelp>
<format>user</format>
- <description>ocserv config file loaded by matching file in configured directory to the users username</description>
+ <description>OpenConnect config file loaded by matching file in configured directory to the users username</description>
</valueHelp>
<valueHelp>
<format>group</format>
- <description>ocserv config file loaded by matching RADIUS class attribute in the RADIUS server response to a file in the configured directory</description>
+ <description>OpenConnect config file loaded by matching RADIUS class attribute in the RADIUS server response to a file in the configured directory</description>
</valueHelp>
<constraint>
<regex>(user|group)</regex>
</constraint>
- <constraintErrorMessage>Invalid config-per-x. Must be one of: user, group </constraintErrorMessage>
+ <constraintErrorMessage>Invalid mode. Must be one of: user, group</constraintErrorMessage>
<completionHelp>
<list>user group</list>
</completionHelp>
@@ -26,10 +26,10 @@
</leafNode>
<leafNode name="directory">
<properties>
- <help>Child directory of /config/auth e.g. /config/auth/ocserv/config-per-user</help>
+ <help>Directory to configure OpenConnect to use for matching username/group to config file</help>
<valueHelp>
<format>filename</format>
- <description>Child directory of /config/auth e.g. /config/auth/ocserv/config-per-user</description>
+ <description>Must be a child directory of /config/auth e.g. /config/auth/ocserv/config-per-user</description>
</valueHelp>
<constraint>
<validator name="file-path" argument="--directory --parent-dir /config/auth --strict"/>