Skip to content

Inputs & Outputs

VcenterConnection

  • Contains vCenter connection details

  • It is used as an input to many of the actions in this plugin

  • The example below shows the dictionary structure in YAML

  • See the required and optional keys underneath the example

Supplying Credentials

You should always use a PPA Vault integration to provide credentials to a plugin action.

Example

1
2
3
4
5
6
vcenter_connection:
  address: 1.2.3.4
  username: [username]
  password: [password]
  port: 443
  verify_ssl: true

Required Keys

address: Domain Controller IP or DNS address.

username: Username for authentication.

password: Password for authentication.

Optional Keys

port: The port to connect to vCenter (defaults to 443).

verify_ssl: A flag to verify server certificate against local default certificates (defaults to true).

VirtualMachine

  • Contains Vmware virtual machine attributes
All Virtual Machine Keys

uuid: Virtual machine unique identifier.

name: Virtual machine name.

operating_system: Name of the guest operating system.

hostname: Hostname of the virtual machine.

ip_address: IP address of the virtual machine.

power_state: Virtual machine power state.

memory_size_MB: Memory size in megabytes.

num_cpu: Number of CPUs.

last_booted_at: The date when the machine was last booted, using the format 22:30:04 17/10/2020".