Updated website docs for 18.2.13 (#126)

Signed-off-by: Yograj Shisode <[email protected]>
vmware · Aug 11, 2021 · eeb38ab · eeb38ab
1 parent 8a68c21
commit eeb38ab
Show file tree

Hide file tree

Showing 163 changed files with 1,985 additions and 2,371 deletions.
diff --git a/website/avi.erb b/website/avi.erb
@@ -1,10 +1,7 @@
-
-############################################################################
-# ------------------------------------------------------------------------
-# Copyright 2020 VMware, Inc.  All rights reserved. VMware Confidential
-# ------------------------------------------------------------------------
-###
-
+<!--
+    Copyright 2021 VMware, Inc.
+    SPDX-License-Identifier: Mozilla Public License 2.0
+-->
 <% wrap_layout :inner do %>
   <% content_for :sidebar do %>
     <div class="docs-sidebar hidden-print affix-top" role="complementary">
@@ -25,6 +22,9 @@
             </li>
                       <li<%= sidebar_current("docs-avi-role") %>>
               <a href="/docs/providers/avi/d/avi_role.html">Role</a>
+            </li>
+                      <li<%= sidebar_current("docs-avi-user") %>>
+              <a href="/docs/providers/avi/d/avi_user.html">User</a>
             </li>
                       <li<%= sidebar_current("docs-avi-objectaccesspolicy") %>>
               <a href="/docs/providers/avi/d/avi_objectaccesspolicy.html">ObjectAccessPolicy</a>
@@ -280,6 +280,9 @@
             </li>
 		              <li<%= sidebar_current("docs-avi-role") %>>
               <a href="/docs/providers/avi/r/avi_role.html">Role</a>
+            </li>
+		              <li<%= sidebar_current("docs-avi-user") %>>
+              <a href="/docs/providers/avi/r/avi_user.html">User</a>
             </li>
 		              <li<%= sidebar_current("docs-avi-objectaccesspolicy") %>>
               <a href="/docs/providers/avi/r/avi_objectaccesspolicy.html">ObjectAccessPolicy</a>

diff --git a/website/docs/d/avi_actiongroupconfig.html.markdown b/website/docs/d/avi_actiongroupconfig.html.markdown
@@ -1,9 +1,7 @@
-############################################################################
-# ------------------------------------------------------------------------
-# Copyright 2020 VMware, Inc.  All rights reserved. VMware Confidential
-# ------------------------------------------------------------------------
-###
-
+<!--
+    Copyright 2021 VMware, Inc.
+    SPDX-License-Identifier: Mozilla Public License 2.0
+-->
 ---
 layout: "avi"
 page_title: "AVI: avi_actiongroupconfig"
@@ -34,15 +32,15 @@ data "avi_actiongroupconfig" "foo_actiongroupconfig" {
 
 In addition to all arguments above, the following attributes are exported:
 
-* `action_script_config_ref` - Reference of the action script configuration to be used.
+* `action_script_config_ref` - Reference of the action script configuration to be used. It is a reference to an object of type alertscriptconfig.
 * `autoscale_trigger_notification` - Trigger notification to autoscale manager.
 * `description` - User defined description for the object.
-* `email_config_ref` - Select the email notification configuration to use when sending alerts via email.
+* `email_config_ref` - Select the email notification configuration to use when sending alerts via email. It is a reference to an object of type alertemailconfig.
 * `external_only` - Generate alert only to external destinations.
-* `level` - When an alert is generated, mark its priority via the alert level.
+* `level` - When an alert is generated, mark its priority via the alert level. Enum options - ALERT_LOW, ALERT_MEDIUM, ALERT_HIGH.
 * `name` - Name of the object.
-* `snmp_trap_profile_ref` - Select the snmp trap notification to use when sending alerts via snmp trap.
-* `syslog_config_ref` - Select the syslog notification configuration to use when sending alerts via syslog.
+* `snmp_trap_profile_ref` - Select the snmp trap notification to use when sending alerts via snmp trap. It is a reference to an object of type snmptrapprofile.
+* `syslog_config_ref` - Select the syslog notification configuration to use when sending alerts via syslog. It is a reference to an object of type alertsyslogconfig.
 * `tenant_ref` - It is a reference to an object of type tenant.
 * `uuid` - Unique object identifier of the object.
 
diff --git a/website/docs/d/avi_alertconfig.html.markdown b/website/docs/d/avi_alertconfig.html.markdown
@@ -1,9 +1,7 @@
-############################################################################
-# ------------------------------------------------------------------------
-# Copyright 2020 VMware, Inc.  All rights reserved. VMware Confidential
-# ------------------------------------------------------------------------
-###
-
+<!--
+    Copyright 2021 VMware, Inc.
+    SPDX-License-Identifier: Mozilla Public License 2.0
+-->
 ---
 layout: "avi"
 page_title: "AVI: avi_alertconfig"
@@ -34,22 +32,22 @@ data "avi_alertconfig" "foo_alertconfig" {
 
 In addition to all arguments above, the following attributes are exported:
 
-* `action_group_ref` - The alert config will trigger the selected alert action, which can send notifications and execute a controlscript.
+* `action_group_ref` - The alert config will trigger the selected alert action, which can send notifications and execute a controlscript. It is a reference to an object of type actiongroupconfig.
 * `alert_rule` - List of filters matching on events or client logs used for triggering alerts.
 * `autoscale_alert` - This alert config applies to auto scale alerts.
-* `category` - Determines whether an alert is raised immediately when event occurs (realtime) or after specified number of events occurs within rolling time window.
+* `category` - Determines whether an alert is raised immediately when event occurs (realtime) or after specified number of events occurs within rolling time window. Enum options - REALTIME, ROLLINGWINDOW, WATERMARK.
 * `description` - A custom description field.
 * `enabled` - Enable or disable this alert config from generating new alerts.
-* `expiry_time` - An alert is expired and deleted after the expiry time has elapsed.
+* `expiry_time` - An alert is expired and deleted after the expiry time has elapsed. The original event triggering the alert remains in the event's log. Allowed values are 1-31536000.
 * `name` - Name of the alert configuration.
 * `obj_uuid` - Uuid of the resource for which alert was raised.
-* `object_type` - The object type to which the alert config is associated with.
+* `object_type` - The object type to which the alert config is associated with. Valid object types are - virtual service, pool, service engine. Enum options - VIRTUALSERVICE, POOL, HEALTHMONITOR, NETWORKPROFILE, APPLICATIONPROFILE, HTTPPOLICYSET, DNSPOLICY, SECURITYPOLICY, IPADDRGROUP, STRINGGROUP, SSLPROFILE, SSLKEYANDCERTIFICATE, NETWORKSECURITYPOLICY, APPLICATIONPERSISTENCEPROFILE, ANALYTICSPROFILE, VSDATASCRIPTSET, TENANT, PKIPROFILE, AUTHPROFILE, CLOUD...
 * `recommendation` - Placeholder for description of property recommendation of obj type alertconfig field type string  type str.
-* `rolling_window` - Only if the number of events is reached or exceeded within the time window will an alert be generated.
-* `source` - Signifies system events or the type of client logsused in this alert configuration.
+* `rolling_window` - Only if the number of events is reached or exceeded within the time window will an alert be generated. Allowed values are 1-31536000.
+* `source` - Signifies system events or the type of client logsused in this alert configuration. Enum options - CONN_LOGS, APP_LOGS, EVENT_LOGS, METRICS.
 * `summary` - Summary of reason why alert is generated.
 * `tenant_ref` - It is a reference to an object of type tenant.
-* `threshold` - An alert is created only when the number of events meets or exceeds this number within the chosen time frame.
-* `throttle` - Alerts are suppressed (throttled) for this duration of time since the last alert was raised for this alert config.
+* `threshold` - An alert is created only when the number of events meets or exceeds this number within the chosen time frame. Allowed values are 1-65536.
+* `throttle` - Alerts are suppressed (throttled) for this duration of time since the last alert was raised for this alert config. Allowed values are 0-31536000.
 * `uuid` - Unique object identifier of the object.
 
diff --git a/website/docs/d/avi_alertemailconfig.html.markdown b/website/docs/d/avi_alertemailconfig.html.markdown
@@ -1,9 +1,7 @@
-############################################################################
-# ------------------------------------------------------------------------
-# Copyright 2020 VMware, Inc.  All rights reserved. VMware Confidential
-# ------------------------------------------------------------------------
-###
-
+<!--
+    Copyright 2021 VMware, Inc.
+    SPDX-License-Identifier: Mozilla Public License 2.0
+-->
 ---
 layout: "avi"
 page_title: "AVI: avi_alertemailconfig"

diff --git a/website/docs/d/avi_alertscriptconfig.html.markdown b/website/docs/d/avi_alertscriptconfig.html.markdown
@@ -1,9 +1,7 @@
-############################################################################
-# ------------------------------------------------------------------------
-# Copyright 2020 VMware, Inc.  All rights reserved. VMware Confidential
-# ------------------------------------------------------------------------
-###
-
+<!--
+    Copyright 2021 VMware, Inc.
+    SPDX-License-Identifier: Mozilla Public License 2.0
+-->
 ---
 layout: "avi"
 page_title: "AVI: avi_alertscriptconfig"
@@ -34,7 +32,7 @@ data "avi_alertscriptconfig" "foo_alertscriptconfig" {
 
 In addition to all arguments above, the following attributes are exported:
 
-* `action_script` - User defined alert action script.
+* `action_script` - User defined alert action script. Please refer to kb.avinetworks.com for more information.
 * `name` - A user-friendly name of the script.
 * `tenant_ref` - It is a reference to an object of type tenant.
 * `uuid` - Unique object identifier of the object.

diff --git a/website/docs/d/avi_alertsyslogconfig.html.markdown b/website/docs/d/avi_alertsyslogconfig.html.markdown
@@ -1,9 +1,7 @@
-############################################################################
-# ------------------------------------------------------------------------
-# Copyright 2020 VMware, Inc.  All rights reserved. VMware Confidential
-# ------------------------------------------------------------------------
-###
-
+<!--
+    Copyright 2021 VMware, Inc.
+    SPDX-License-Identifier: Mozilla Public License 2.0
+-->
 ---
 layout: "avi"
 page_title: "AVI: avi_alertsyslogconfig"