virtual_mac_virtual_addresses

Creates, updates, deletes, gets or lists a virtual_mac_virtual_addresses resource.

Overview

Name	virtual_mac_virtual_addresses
Type	Resource
Id	ovh.dedicated_server.virtual_mac_virtual_addresses

Fields

The following fields are returned by SELECT queries:

get

successful operation

Name	Datatype	Description
virtual_machine_name	string	Friendly name of your Virtual Machine behind this IP/MAC (wire: virtualMachineName)
ip_address	string (ipv4)	IP address (example: 192.0.2.0) (wire: ipAddress)

list

ip address linked with this virtual mac address

Name	Datatype	Description
virtual_machine_name	string	Friendly name of your Virtual Machine behind this IP/MAC (wire: virtualMachineName)
ip_address	string (ipv4)	IP address (example: 192.0.2.0) (wire: ipAddress)

Methods

The following methods are available for this resource:

Name	Accessible by	Required Params	Optional Params	Description
get	select	ip_address, mac_address, service_name		Get an IP of a virtual MAC. Returns an IPv4 address associated with the virtual MAC and the friendly name of the virtual machine behind it.
list	select	mac_address, service_name	x_pagination_mode	List IPs of a virtual MAC. Returns the IPv4 addresses associated with the virtual MAC. A virtual MAC can be associated with one or more IPs.
create	insert	mac_address, service_name, ip_address, virtual_machine_name		Add an IP to a virtual MAC. Associates an IPv4 address with the virtual MAC, with a friendly name for the virtual machine behind it. Returns a task.
delete	delete	ip_address, mac_address, service_name		Remove an IP from a virtual MAC. Removes the IPv4 address from the virtual MAC and returns a task. Removing the last linked IP also deletes the virtual MAC.

Parameters

Parameters can be passed in the WHERE clause of a query. Check the Methods section to see which parameters are required or optional for each operation.

Name	Datatype	Description
api_host	string	The OVHcloud API host. Selected by OVH_ENDPOINT (ovh-eu, ovh-ca or ovh-us; default ovh-eu). (default: api.eu.ovhcloud.com, x-stackQL-envVarSelector: {"envVar":"OVH_ENDPOINT","default":"ovh-eu","values":{"ovh-eu":"api.eu.ovhcloud.com","ovh-ca":"api.ca.ovhcloud.com","ovh-us":"api.us.ovhcloud.com"}})
ip_address	string (ipv4)	IP address (wire: ipAddress)
mac_address	string	Virtual MAC address in 00:00:00:00:00:00 format (wire: macAddress)
service_name	string	The internal name of your dedicated server (wire: serviceName)
x_pagination_mode	string	Sent as CachedObjectList-Pages by default so the list returns the full objects rather than their identifiers. (wire: X-Pagination-Mode)

SELECT examples

get

Get an IP of a virtual MAC. Returns an IPv4 address associated with the virtual MAC and the friendly name of the virtual machine behind it.

SELECT
virtual_machine_name,
ip_address
FROM ovh.dedicated_server.virtual_mac_virtual_addresses
WHERE ip_address = '{{ ip_address }}' -- required
AND mac_address = '{{ mac_address }}' -- required
AND service_name = '{{ service_name }}' -- required
;

list

List IPs of a virtual MAC. Returns the IPv4 addresses associated with the virtual MAC. A virtual MAC can be associated with one or more IPs.

SELECT
virtual_machine_name,
ip_address
FROM ovh.dedicated_server.virtual_mac_virtual_addresses
WHERE mac_address = '{{ mac_address }}' -- required
AND service_name = '{{ service_name }}' -- required
AND x_pagination_mode = '{{ x_pagination_mode }}'
;

INSERT examples

create

Add an IP to a virtual MAC. Associates an IPv4 address with the virtual MAC, with a friendly name for the virtual machine behind it. Returns a task.

INSERT INTO ovh.dedicated_server.virtual_mac_virtual_addresses (
ip_address,
virtual_machine_name,
mac_address,
service_name
)
SELECT 
'{{ ip_address }}' /* required */,
'{{ virtual_machine_name }}' /* required */,
'{{ mac_address }}',
'{{ service_name }}'
RETURNING
planned_intervention_id,
task_id,
change_uuid,
comment,
done_date,
function,
last_update,
need_schedule,
note,
start_date,
status,
tags,
ticket_reference
;

Manifest

# Description fields are for documentation purposes
- name: virtual_mac_virtual_addresses
props:
  - name: mac_address
    value: "{{ mac_address }}"
    description: Required parameter for the virtual_mac_virtual_addresses resource.
  - name: service_name
    value: "{{ service_name }}"
    description: Required parameter for the virtual_mac_virtual_addresses resource.
  - name: ip_address
    value: "{{ ip_address }}"
    description: |
      IPv4 address (e.g., 192.0.2.0)
  - name: virtual_machine_name
    value: "{{ virtual_machine_name }}"
    description: |
      Friendly name of your Virtual Machine behind this IP/MAC

DELETE examples

delete

Remove an IP from a virtual MAC. Removes the IPv4 address from the virtual MAC and returns a task. Removing the last linked IP also deletes the virtual MAC.

DELETE FROM ovh.dedicated_server.virtual_mac_virtual_addresses
WHERE ip_address = '{{ ip_address }}' --required
AND mac_address = '{{ mac_address }}' --required
AND service_name = '{{ service_name }}' --required
;