service_authorized_ips

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

Overview

Name	service_authorized_ips
Type	Resource
Id	ovh.email_exchange.service_authorized_ips

Fields

The following fields are returned by SELECT queries:

get

successful operation

Name	Datatype	Description
display_name	string	display name (wire: displayName)
creation_date	string (date-time)	Creation date (wire: creationDate)
https	boolean	Webmail,outlook,web Service(EWS) and active sync access (port 443) (wire: HTTPS)
imap	boolean	IMAP access (port 143) (wire: IMAP)
imaps	boolean	IMAPS access (port 993) (wire: IMAPS)
ip	string (ipv4-block)	Allowed IP (example: 192.0.2.0/24)
pop	boolean	POP access (port 110) (wire: POP)
pops	boolean	POPS access (port 995) (wire: POPS)
smtp	boolean	SMTP access (port 25) (wire: SMTP)
smtps	boolean	SMTPS access (port 587) (wire: SMTPS)
status	string	Authorized IP status (creating, deleting, ok)
update_date	string (date-time)	Last update date (wire: updateDate)

list

Get authorized IPs for POP(s),IMAP(s), SMTP(s) and HTTP(s)

Name	Datatype	Description
display_name	string	display name (wire: displayName)
creation_date	string (date-time)	Creation date (wire: creationDate)
https	boolean	Webmail,outlook,web Service(EWS) and active sync access (port 443) (wire: HTTPS)
imap	boolean	IMAP access (port 143) (wire: IMAP)
imaps	boolean	IMAPS access (port 993) (wire: IMAPS)
ip	string (ipv4-block)	Allowed IP (example: 192.0.2.0/24)
pop	boolean	POP access (port 110) (wire: POP)
pops	boolean	POPS access (port 995) (wire: POPS)
smtp	boolean	SMTP access (port 25) (wire: SMTP)
smtps	boolean	SMTPS access (port 587) (wire: SMTPS)
status	string	Authorized IP status (creating, deleting, ok)
update_date	string (date-time)	Last update date (wire: updateDate)

Methods

The following methods are available for this resource:

Name	Accessible by	Required Params	Optional Params	Description
get	select	exchange_service, ip, organization_name		Get an authorized IP. Returns the display name and status of the IP block, and the accesses it is allowed: HTTPS, IMAP, IMAPS, POP, POPS, SMTP and SMTPS.
list	select	exchange_service, organization_name	x_pagination_mode	List authorized IPs. Returns the IP blocks allowed to access the service over POP, IMAP, SMTP or HTTPS, with or without SSL.
create	insert	exchange_service, organization_name, ip		Add an authorized IP. Allows an IP block to access the service over the selected protocols: HTTPS, IMAP, IMAPS, POP, POPS, SMTP and SMTPS. Returns the task.
update	update	exchange_service, ip, organization_name		Update an authorized IP. Updates the display name of the IP block and the accesses it is allowed: HTTPS, IMAP, IMAPS, POP, POPS, SMTP and SMTPS.
delete	delete	exchange_service, ip, organization_name		Delete an authorized IP. Removes the IP block from the IPs allowed to reach the service, and returns the task.

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"}})
exchange_service	string	The internal name of your exchange service (wire: exchangeService)
ip	string (ipv4-block)	Allowed IP
organization_name	string	The internal name of your exchange organization (wire: organizationName)
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 authorized IP. Returns the display name and status of the IP block, and the accesses it is allowed: HTTPS, IMAP, IMAPS, POP, POPS, SMTP and SMTPS.

SELECT
display_name,
creation_date,
https,
imap,
imaps,
ip,
pop,
pops,
smtp,
smtps,
status,
update_date
FROM ovh.email_exchange.service_authorized_ips
WHERE exchange_service = '{{ exchange_service }}' -- required
AND ip = '{{ ip }}' -- required
AND organization_name = '{{ organization_name }}' -- required
;

list

List authorized IPs. Returns the IP blocks allowed to access the service over POP, IMAP, SMTP or HTTPS, with or without SSL.

SELECT
display_name,
creation_date,
https,
imap,
imaps,
ip,
pop,
pops,
smtp,
smtps,
status,
update_date
FROM ovh.email_exchange.service_authorized_ips
WHERE exchange_service = '{{ exchange_service }}' -- required
AND organization_name = '{{ organization_name }}' -- required
AND x_pagination_mode = '{{ x_pagination_mode }}'
;

INSERT examples

create

Add an authorized IP. Allows an IP block to access the service over the selected protocols: HTTPS, IMAP, IMAPS, POP, POPS, SMTP and SMTPS. Returns the task.

INSERT INTO ovh.email_exchange.service_authorized_ips (
https,
imap,
imaps,
ip,
pop,
pops,
smtp,
smtps,
display_name,
exchange_service,
organization_name
)
SELECT 
{{ https }},
{{ imap }},
{{ imaps }},
'{{ ip }}' /* required */,
{{ pop }},
{{ pops }},
{{ smtp }},
{{ smtps }},
'{{ display_name }}',
'{{ exchange_service }}',
'{{ organization_name }}'
RETURNING
id,
finish_date,
function,
status,
todo_date
;

Manifest

# Description fields are for documentation purposes
- name: service_authorized_ips
props:
  - name: exchange_service
    value: "{{ exchange_service }}"
    description: Required parameter for the service_authorized_ips resource.
  - name: organization_name
    value: "{{ organization_name }}"
    description: Required parameter for the service_authorized_ips resource.
  - name: https
    value: {{ https }}
    description: |
      Webmail,outlook,web Service(EWS) and active sync access (port 443)
  - name: imap
    value: {{ imap }}
    description: |
      IMAP access (port 143)
  - name: imaps
    value: {{ imaps }}
    description: |
      IMAPS access (port 993)
  - name: ip
    value: "{{ ip }}"
    description: |
      Authorized IP
  - name: pop
    value: {{ pop }}
    description: |
      POP access (port 110)
  - name: pops
    value: {{ pops }}
    description: |
      POPS access (port 995)
  - name: smtp
    value: {{ smtp }}
    description: |
      SMTP access (port 25)
  - name: smtps
    value: {{ smtps }}
    description: |
      SMTPS access (port 587)
  - name: display_name
    value: "{{ display_name }}"
    description: |
      display name information

UPDATE examples

update

Update an authorized IP. Updates the display name of the IP block and the accesses it is allowed: HTTPS, IMAP, IMAPS, POP, POPS, SMTP and SMTPS.

UPDATE ovh.email_exchange.service_authorized_ips
SET 
https = {{ https }},
imap = {{ imap }},
imaps = {{ imaps }},
pop = {{ pop }},
pops = {{ pops }},
smtp = {{ smtp }},
smtps = {{ smtps }},
display_name = '{{ display_name }}'
WHERE 
exchange_service = '{{ exchange_service }}' --required
AND ip = '{{ ip }}' --required
AND organization_name = '{{ organization_name }}' --required;

DELETE examples

delete

Delete an authorized IP. Removes the IP block from the IPs allowed to reach the service, and returns the task.

DELETE FROM ovh.email_exchange.service_authorized_ips
WHERE exchange_service = '{{ exchange_service }}' --required
AND ip = '{{ ip }}' --required
AND organization_name = '{{ organization_name }}' --required
;