From 1b58f4b0195b866b5d322c314ce66dcf72f8a9af Mon Sep 17 00:00:00 2001 From: GomathiselviS Date: Fri, 31 Jul 2020 17:53:09 -0400 Subject: Update docs (#73) vyos: Update docs Reviewed-by: GomathiselviS https://github.com/GomathiselviS --- docs/vyos.vyos.vyos_logging_module.rst | 114 +++++++++++++++++++++++++++++---- 1 file changed, 102 insertions(+), 12 deletions(-) (limited to 'docs/vyos.vyos.vyos_logging_module.rst') diff --git a/docs/vyos.vyos.vyos_logging_module.rst b/docs/vyos.vyos.vyos_logging_module.rst index 37d9a34e..c54f6361 100644 --- a/docs/vyos.vyos.vyos_logging_module.rst +++ b/docs/vyos.vyos.vyos_logging_module.rst @@ -39,22 +39,114 @@ Parameters aggregate
- - -
+ list + / elements=dictionary
List of logging definitions.
+ + + + +
+ dest + +
+ string +
+ + + + + +
Destination of the logs.
+ + + + + +
+ facility + +
+ string +
+ + + + +
Set logging facility.
+ + + + + +
+ level + +
+ string +
+ + + + +
Set logging severity levels.
+ + + + + +
+ name + +
+ string +
+ + + + +
If value of dest is file it indicates file-name, for user it indicates username and for host indicates the host name to be notified.
+ + + +
+ state + +
+ string +
+ + + + + +
State of the logging configuration.
+ + + +
dest
- - + string
@@ -76,7 +168,7 @@ Parameters facility
- - + string
@@ -91,7 +183,7 @@ Parameters level
- - + string
@@ -106,7 +198,7 @@ Parameters name
- - + string
@@ -142,7 +234,7 @@ Parameters
string - / required
+ @@ -177,8 +269,7 @@ Parameters - Default:
22
- +
Specifies the port to use when building the connection to the remote device.
@@ -210,8 +301,7 @@ Parameters - Default:
10
- +
Specifies the timeout in seconds for communicating with the network device for either connecting or sending commands. If the timeout is exceeded before the operation is completed, the module will error.
@@ -239,7 +329,7 @@ Parameters state
- - + string
-- cgit v1.2.3