Com::Vmware::Vcenter::Ovf::ExtraConfigParams Class Reference

Inheritance diagram for Com::Vmware::Vcenter::Ovf::ExtraConfigParams:

Avaliable Methods
public method	set_type ()
public method	get_extra_configs ()
public method	get_exclude_keys ()
public method	set_exclude_keys ()
public method	set_extra_configs ()
public method	set_include_keys ()
public method	new ()
public method	get_type ()
public method	get_include_keys ()

Detailed Description

The Com::Vmware::Vcenter::Ovf::ExtraConfigParams class contains the parameters with information about the vmw:ExtraConfig elements in an OVF package.

vmw:ExtraConfig elements can be used to specify configuration settings that are transferred directly to the .vmx file.

The behavior of the vmw:ExtraConfig element is similar to the extraConfig property of the VirtualMachineConfigSpec object in the VMware vSphere API. Thus, the same restrictions apply, such as you cannot set values that could otherwise be set with other properties in the VirtualMachineConfigSpec object. See the VMware vSphere API reference for details on this.

See :func:Com::Vmware::Vcenter::Ovf::LibraryItem.deploy and :func:Com::Vmware::Vcenter::Ovf::LibraryItem.filter .

Member Function Documentation

public method Com::Vmware::Vcenter::Ovf::ExtraConfigParams::get_exclude_keys

(

)

Gets the value of 'exclude_keys' property.

Return values

exclude_keys

- The current value of the field. Specifies which extra configuration items in the list in the extraConfigs field should be ignored during deployment.

If set, the given keys for extra configurations will be ignored during deployment. The key is defined in the :attr:Com::Vmware::Vcenter::Ovf::ExtraConfig.key field .

optional#

Code:

public method Com::Vmware::Vcenter::Ovf::ExtraConfigParams::get_extra_configs

(

)

Gets the value of 'extra_configs' property.

Return values

extra_configs

- The current value of the field. List* of vmw:ExtraConfig elements in the OVF package. optional#

Code:

public method Com::Vmware::Vcenter::Ovf::ExtraConfigParams::get_include_keys

(

)

Gets the value of 'include_keys' property.

Return values

include_keys

- The current value of the field. Specifies which extra configuration items in the list in the extraConfigs field should be included during deployment.

If set, all but the given keys for extra configurations will be ignored during deployment. The key is defined in the :attr:Com::Vmware::Vcenter::Ovf::ExtraConfig.key field .

optional#

Code:

public method Com::Vmware::Vcenter::Ovf::ExtraConfigParams::get_type

(

)

Gets the value of 'type' property.

Return values

type	- The current value of the field. Unique identifier describing the type of the OVF parameters. The value is the name of the OVF parameters class . optional#

Code:

public method Com::Vmware::Vcenter::Ovf::ExtraConfigParams::new

(

)

Constructor to initialize the Com::Vmware::Vcenter::Ovf::ExtraConfigParams structure

Return values

Blessed

object

Code:

public method Com::Vmware::Vcenter::Ovf::ExtraConfigParams::set_exclude_keys

(

)

Sets the given value for 'exclude_keys' property.

Parameters

exclude_keys

- New value for the field. Specifies which extra configuration items in the list in the extraConfigs field should be ignored during deployment.

If set, the given keys for extra configurations will be ignored during deployment. The key is defined in the :attr:Com::Vmware::Vcenter::Ovf::ExtraConfig.key field .

Code:

public method Com::Vmware::Vcenter::Ovf::ExtraConfigParams::set_extra_configs

(

)

Sets the given value for 'extra_configs' property.

Parameters

extra_configs

- New value for the field. List* of vmw:ExtraConfig elements in the OVF package.

Code:

public method Com::Vmware::Vcenter::Ovf::ExtraConfigParams::set_include_keys

(

)

Sets the given value for 'include_keys' property.

Parameters

include_keys

- New value for the field. Specifies which extra configuration items in the list in the extraConfigs field should be included during deployment.

If set, all but the given keys for extra configurations will be ignored during deployment. The key is defined in the :attr:Com::Vmware::Vcenter::Ovf::ExtraConfig.key field .

Code:

public method Com::Vmware::Vcenter::Ovf::ExtraConfigParams::set_type

(

)

Sets the given value for 'type' property.

Parameters

type	- New value for the field. Unique identifier describing the type of the OVF parameters. The value is the name of the OVF parameters class .

Code:

---

The documentation for this class was generated from the following file:

• Com/Vmware/Vcenter/Ovf/ExtraConfigParams.pm