NSX plugin: Update parameter descriptions
This change updates description of individual parameters based on the following points. * Add Optional/Required flag * Explain the default values Change-Id: I89c4d6b72845f01f260b3eaa4bb16b6bc97e91ea
This commit is contained in:
parent
03396ad2fb
commit
e6c0837aba
@ -4,52 +4,66 @@
|
|||||||
# === Parameters
|
# === Parameters
|
||||||
#
|
#
|
||||||
# [*default_overlay_tz*]
|
# [*default_overlay_tz*]
|
||||||
# Name or UUID of the default overlay Transport Zone to be used for creating
|
# (Optional) Name or UUID of the default overlay Transport Zone to be used
|
||||||
# tunneled isolated "Neutron" networks. This option MUST be specified.
|
# for creating tunneled isolated "Neutron" networks. This option MUST be
|
||||||
|
# specified.
|
||||||
|
# Defaults to $::os_service_default
|
||||||
#
|
#
|
||||||
# [*default_vlan_tz*]
|
# [*default_vlan_tz*]
|
||||||
# (optional) Name or UUID of the default VLAN Transport Zone to be used for
|
# (Optional) Name or UUID of the default VLAN Transport Zone to be used for
|
||||||
# creating VLAN networks.
|
# creating VLAN networks.
|
||||||
|
# Defaults to $::os_service_default
|
||||||
#
|
#
|
||||||
# [*default_bridge_cluster*]
|
# [*default_bridge_cluster*]
|
||||||
# (optional) Name or UUID of the default NSX bridge cluster that will be
|
# (Optional) Name or UUID of the default NSX bridge cluster that will be
|
||||||
# used to perform L2 gateway bridging between VXLAN and VLAN networks.
|
# used to perform L2 gateway bridging between VXLAN and VLAN networks.
|
||||||
|
# Defaults to $::os_service_default
|
||||||
#
|
#
|
||||||
# [*default_tier0_router*]
|
# [*default_tier0_router*]
|
||||||
# Name or UUID of the pre-created default tier0 (provider) router on NSX
|
# (Optional) Name or UUID of the pre-created default tier0 (provider) router
|
||||||
# backend. This option is used to create external networks and MUST be
|
# on NSX backend. This option is used to create external networks and MUST be
|
||||||
# specified.
|
# specified.
|
||||||
|
# Defaults to $::os_service_default
|
||||||
#
|
#
|
||||||
# [*nsx_api_managers*]
|
# [*nsx_api_managers*]
|
||||||
# Comma separated NSX manager IP addresses. This option MUST be specified.
|
# (Optional) Comma separated NSX manager IP addresses. This option MUST be
|
||||||
|
# specified.
|
||||||
|
# Defaults to $::os_service_default
|
||||||
#
|
#
|
||||||
# [*nsx_api_user*]
|
# [*nsx_api_user*]
|
||||||
# The username for NSX manager.
|
# (Optional) The username for NSX manager.
|
||||||
|
# Defaults to $::os_service_default
|
||||||
#
|
#
|
||||||
# [*nsx_api_password*]
|
# [*nsx_api_password*]
|
||||||
# The password for NSX manager.
|
# (Optional) The password for NSX manager.
|
||||||
|
# Defaults to $::os_service_default
|
||||||
#
|
#
|
||||||
# [*dhcp_profile*]
|
# [*dhcp_profile*]
|
||||||
# Name or UUID of the pre-created DHCP profile on NSX backend to support
|
# (Optional) Name or UUID of the pre-created DHCP profile on NSX backend to
|
||||||
# native DHCP. This option MUST be specified if native_dhcp_metadata is True.
|
# support native DHCP. This option MUST be specified if native_dhcp_metadata
|
||||||
|
# is True.
|
||||||
|
# Defaults to $::os_service_default
|
||||||
#
|
#
|
||||||
# [*dhcp_relay_service*]
|
# [*dhcp_relay_service*]
|
||||||
# (optional) This is the name or UUID of the NSX relay service that will be
|
# (Optional) This is the name or UUID of the NSX relay service that will be
|
||||||
# used to enable DHCP relay on router ports.
|
# used to enable DHCP relay on router ports.
|
||||||
|
# Defaults to $::os_service_default
|
||||||
#
|
#
|
||||||
# [*metadata_proxy*]
|
# [*metadata_proxy*]
|
||||||
# Name or UUID of the pre-created Metadata Proxy on NSX backend. This option
|
# (Optional) Name or UUID of the pre-created Metadata Proxy on NSX backend.
|
||||||
# MUST be specified if native_dhcp_metadata is True.
|
# This option MUST be specified if native_dhcp_metadata is True.
|
||||||
|
# Defaults to $::os_service_default
|
||||||
#
|
#
|
||||||
# [*native_dhcp_metadata*]
|
# [*native_dhcp_metadata*]
|
||||||
# Flag to enable native DHCP and Metadata.
|
# (Optional) Flag to enable native DHCP and Metadata.
|
||||||
|
# Defaults to $::os_service_default
|
||||||
#
|
#
|
||||||
# [*package_ensure*]
|
# [*package_ensure*]
|
||||||
# (optional) Ensure state for package.
|
# (Optional) Ensure state for package.
|
||||||
# Defaults to 'present'.
|
# Defaults to 'present'.
|
||||||
#
|
#
|
||||||
# [*purge_config*]
|
# [*purge_config*]
|
||||||
# (optional) Whether to set only the specified config options
|
# (Optional) Whether to set only the specified config options
|
||||||
# in the nvp config.
|
# in the nvp config.
|
||||||
# Defaults to false.
|
# Defaults to false.
|
||||||
#
|
#
|
||||||
|
Loading…
Reference in New Issue
Block a user