Skip to content

Commit eeb38ab

Browse files
yograjshisodeyograjshisode
authored
Updated website docs for 18.2.13 (#126)
Signed-off-by: Yograj Shisode <[email protected]>
1 parent 8a68c21 commit eeb38ab

File tree

163 files changed

+1985
-2371
lines changed

Some content is hidden

Large Commits have some content hidden by default. Use the searchbox below for content that may be hidden.

163 files changed

+1985
-2371
lines changed

Diff for: ‎website/avi.erb

+10-7
Original file line numberDiff line numberDiff line change
@@ -1,10 +1,7 @@
1-
2-
############################################################################
3-
# ------------------------------------------------------------------------
4-
# Copyright 2020 VMware, Inc. All rights reserved. VMware Confidential
5-
# ------------------------------------------------------------------------
6-
###
7-
1+
<!--
2+
Copyright 2021 VMware, Inc.
3+
SPDX-License-Identifier: Mozilla Public License 2.0
4+
-->
85
<% wrap_layout :inner do %>
96
<% content_for :sidebar do %>
107
<div class="docs-sidebar hidden-print affix-top" role="complementary">
@@ -25,6 +22,9 @@
2522
</li>
2623
<li<%= sidebar_current("docs-avi-role") %>>
2724
<a href="/docs/providers/avi/d/avi_role.html">Role</a>
25+
</li>
26+
<li<%= sidebar_current("docs-avi-user") %>>
27+
<a href="/docs/providers/avi/d/avi_user.html">User</a>
2828
</li>
2929
<li<%= sidebar_current("docs-avi-objectaccesspolicy") %>>
3030
<a href="/docs/providers/avi/d/avi_objectaccesspolicy.html">ObjectAccessPolicy</a>
@@ -280,6 +280,9 @@
280280
</li>
281281
<li<%= sidebar_current("docs-avi-role") %>>
282282
<a href="/docs/providers/avi/r/avi_role.html">Role</a>
283+
</li>
284+
<li<%= sidebar_current("docs-avi-user") %>>
285+
<a href="/docs/providers/avi/r/avi_user.html">User</a>
283286
</li>
284287
<li<%= sidebar_current("docs-avi-objectaccesspolicy") %>>
285288
<a href="/docs/providers/avi/r/avi_objectaccesspolicy.html">ObjectAccessPolicy</a>

Diff for: ‎website/docs/d/avi_actiongroupconfig.html.markdown

+9-11
Original file line numberDiff line numberDiff line change
@@ -1,9 +1,7 @@
1-
############################################################################
2-
# ------------------------------------------------------------------------
3-
# Copyright 2020 VMware, Inc. All rights reserved. VMware Confidential
4-
# ------------------------------------------------------------------------
5-
###
6-
1+
<!--
2+
Copyright 2021 VMware, Inc.
3+
SPDX-License-Identifier: Mozilla Public License 2.0
4+
-->
75
---
86
layout: "avi"
97
page_title: "AVI: avi_actiongroupconfig"
@@ -34,15 +32,15 @@ data "avi_actiongroupconfig" "foo_actiongroupconfig" {
3432

3533
In addition to all arguments above, the following attributes are exported:
3634

37-
* `action_script_config_ref` - Reference of the action script configuration to be used.
35+
* `action_script_config_ref` - Reference of the action script configuration to be used. It is a reference to an object of type alertscriptconfig.
3836
* `autoscale_trigger_notification` - Trigger notification to autoscale manager.
3937
* `description` - User defined description for the object.
40-
* `email_config_ref` - Select the email notification configuration to use when sending alerts via email.
38+
* `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.
4139
* `external_only` - Generate alert only to external destinations.
42-
* `level` - When an alert is generated, mark its priority via the alert level.
40+
* `level` - When an alert is generated, mark its priority via the alert level. Enum options - ALERT_LOW, ALERT_MEDIUM, ALERT_HIGH.
4341
* `name` - Name of the object.
44-
* `snmp_trap_profile_ref` - Select the snmp trap notification to use when sending alerts via snmp trap.
45-
* `syslog_config_ref` - Select the syslog notification configuration to use when sending alerts via syslog.
42+
* `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.
43+
* `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.
4644
* `tenant_ref` - It is a reference to an object of type tenant.
4745
* `uuid` - Unique object identifier of the object.
4846

Diff for: ‎website/docs/d/avi_alertconfig.html.markdown

+12-14
Original file line numberDiff line numberDiff line change
@@ -1,9 +1,7 @@
1-
############################################################################
2-
# ------------------------------------------------------------------------
3-
# Copyright 2020 VMware, Inc. All rights reserved. VMware Confidential
4-
# ------------------------------------------------------------------------
5-
###
6-
1+
<!--
2+
Copyright 2021 VMware, Inc.
3+
SPDX-License-Identifier: Mozilla Public License 2.0
4+
-->
75
---
86
layout: "avi"
97
page_title: "AVI: avi_alertconfig"
@@ -34,22 +32,22 @@ data "avi_alertconfig" "foo_alertconfig" {
3432

3533
In addition to all arguments above, the following attributes are exported:
3634

37-
* `action_group_ref` - The alert config will trigger the selected alert action, which can send notifications and execute a controlscript.
35+
* `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.
3836
* `alert_rule` - List of filters matching on events or client logs used for triggering alerts.
3937
* `autoscale_alert` - This alert config applies to auto scale alerts.
40-
* `category` - Determines whether an alert is raised immediately when event occurs (realtime) or after specified number of events occurs within rolling time window.
38+
* `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.
4139
* `description` - A custom description field.
4240
* `enabled` - Enable or disable this alert config from generating new alerts.
43-
* `expiry_time` - An alert is expired and deleted after the expiry time has elapsed.
41+
* `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.
4442
* `name` - Name of the alert configuration.
4543
* `obj_uuid` - Uuid of the resource for which alert was raised.
46-
* `object_type` - The object type to which the alert config is associated with.
44+
* `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...
4745
* `recommendation` - Placeholder for description of property recommendation of obj type alertconfig field type string type str.
48-
* `rolling_window` - Only if the number of events is reached or exceeded within the time window will an alert be generated.
49-
* `source` - Signifies system events or the type of client logsused in this alert configuration.
46+
* `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.
47+
* `source` - Signifies system events or the type of client logsused in this alert configuration. Enum options - CONN_LOGS, APP_LOGS, EVENT_LOGS, METRICS.
5048
* `summary` - Summary of reason why alert is generated.
5149
* `tenant_ref` - It is a reference to an object of type tenant.
52-
* `threshold` - An alert is created only when the number of events meets or exceeds this number within the chosen time frame.
53-
* `throttle` - Alerts are suppressed (throttled) for this duration of time since the last alert was raised for this alert config.
50+
* `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.
51+
* `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.
5452
* `uuid` - Unique object identifier of the object.
5553

Diff for: ‎website/docs/d/avi_alertemailconfig.html.markdown

+4-6
Original file line numberDiff line numberDiff line change
@@ -1,9 +1,7 @@
1-
############################################################################
2-
# ------------------------------------------------------------------------
3-
# Copyright 2020 VMware, Inc. All rights reserved. VMware Confidential
4-
# ------------------------------------------------------------------------
5-
###
6-
1+
<!--
2+
Copyright 2021 VMware, Inc.
3+
SPDX-License-Identifier: Mozilla Public License 2.0
4+
-->
75
---
86
layout: "avi"
97
page_title: "AVI: avi_alertemailconfig"

Diff for: ‎website/docs/d/avi_alertscriptconfig.html.markdown

+5-7
Original file line numberDiff line numberDiff line change
@@ -1,9 +1,7 @@
1-
############################################################################
2-
# ------------------------------------------------------------------------
3-
# Copyright 2020 VMware, Inc. All rights reserved. VMware Confidential
4-
# ------------------------------------------------------------------------
5-
###
6-
1+
<!--
2+
Copyright 2021 VMware, Inc.
3+
SPDX-License-Identifier: Mozilla Public License 2.0
4+
-->
75
---
86
layout: "avi"
97
page_title: "AVI: avi_alertscriptconfig"
@@ -34,7 +32,7 @@ data "avi_alertscriptconfig" "foo_alertscriptconfig" {
3432

3533
In addition to all arguments above, the following attributes are exported:
3634

37-
* `action_script` - User defined alert action script.
35+
* `action_script` - User defined alert action script. Please refer to kb.avinetworks.com for more information.
3836
* `name` - A user-friendly name of the script.
3937
* `tenant_ref` - It is a reference to an object of type tenant.
4038
* `uuid` - Unique object identifier of the object.

Diff for: ‎website/docs/d/avi_alertsyslogconfig.html.markdown

+4-6
Original file line numberDiff line numberDiff line change
@@ -1,9 +1,7 @@
1-
############################################################################
2-
# ------------------------------------------------------------------------
3-
# Copyright 2020 VMware, Inc. All rights reserved. VMware Confidential
4-
# ------------------------------------------------------------------------
5-
###
6-
1+
<!--
2+
Copyright 2021 VMware, Inc.
3+
SPDX-License-Identifier: Mozilla Public License 2.0
4+
-->
75
---
86
layout: "avi"
97
page_title: "AVI: avi_alertsyslogconfig"

0 commit comments

Comments
 (0)