ips

Creates, updates, deletes, gets or lists an ips resource.

Overview

Name	ips
Type	Resource
Id	ovh.ip.ips

Fields

The following fields are returned by SELECT queries:

get

successful operation

Name	Datatype	Description
organisation_id	string	IP block organisation Id (wire: organisationId)
bring_your_own_ip	boolean	Is this IP part of the Bring your own IP program (alpha) (wire: bringYourOwnIp)
campus	string	Where is the IP used/usable (alpha)
can_be_terminated	boolean	Is this IP can be terminated (wire: canBeTerminated)
country	string	IP country (ac, ad, ae, af, ag, ai, al, am, an, ao, aq, ar, as, at, au, aw, ax, az, ba, bb, bd, be, bf, bg, bh, bi, bj, bl, bm, bn, bo, bq, br, bs, bt, bv, bw, by, bz, ca, cc, cd, cf, cg, ch, ci, ck, cl, cm, cn, co, cr, cs, cu, cv, cw, cx, cy, cz, de, dj, dk, dm, do, dz, ec, ee, eg, eh, er, es, et, fc, fd, fi, fj, fk, fm, fo, fr, fx, ga, gb, gd, ge, gf, gg, gh, gi, gl, gm, gn, gp, gq, gr, gs, gt, gu, gw, gy, hk, hm, hn, hr, ht, hu, id, ie, il, im, in, io, iq, ir, is, it, je, jm, jo, jp, ke, kg, kh, ki, km, kn, kp, kr, kw, ky, kz, la, lb, lc, li, lk, lr, ls, lt, lu, lv, ly, ma, mc, md, me, mf, mg, mh, mk, ml, mm, mn, mo, mp, mq, mr, ms, mt, mu, mv, mw, mx, my, mz, na, nc, ne, nf, ng, ni, nl, no, np, nr, nu, nz, om, pa, pe, pf, pg, ph, pk, pl, pm, pn, pr, ps, pt, pw, py, qa, qc, re, ro, rs, ru, rw, sa, sb, sc, sd, se, sg, sh, si, sj, sk, sl, sm, sn, so, sr, ss, st, sv, sx, sy, sz, tc, td, tf, tg, th, tj, tk, tl, tm, tn, to, tp, tr, tt, tv, tw, tz, ua, ug, uk, um, us, uy, uz, va, vc, ve, vg, vi, vn, vu, we, wf, ws, ye, yt, yu, za, zm, zw)
description	string	Custom description on your ip
iam	object	IAM resource metadata
ip	string (ip-block)	IP (v4 or v6) CIDR notation (e.g., 192.0.2.0/24) (example: 192.0.2.0/24)
is_additional_ip	boolean	Is this IP an Additional IP (alpha) (wire: isAdditionalIp)
regions	array	Where is the IP used/usable, in the form of region codenames (alpha)
rir	string	Regional Internet Registry of the IP (alpha)
routed_to	object	Routage information (wire: routedTo)
type	string	Possible values for ip type (cdn, cloud, dedicated, failover, hosted_ssl, housing, loadBalancing, mail, overthebox, pcc, pci, private, vpn, vps, vrack, xdsl)
version	integer	Version of the IP (alpha) (4, 6)

list

Your IP

Name	Datatype	Description
organisation_id	string	IP block organisation Id (wire: organisationId)
bring_your_own_ip	boolean	Is this IP part of the Bring your own IP program (alpha) (wire: bringYourOwnIp)
campus	string	Where is the IP used/usable (alpha)
can_be_terminated	boolean	Is this IP can be terminated (wire: canBeTerminated)
country	string	IP country (ac, ad, ae, af, ag, ai, al, am, an, ao, aq, ar, as, at, au, aw, ax, az, ba, bb, bd, be, bf, bg, bh, bi, bj, bl, bm, bn, bo, bq, br, bs, bt, bv, bw, by, bz, ca, cc, cd, cf, cg, ch, ci, ck, cl, cm, cn, co, cr, cs, cu, cv, cw, cx, cy, cz, de, dj, dk, dm, do, dz, ec, ee, eg, eh, er, es, et, fc, fd, fi, fj, fk, fm, fo, fr, fx, ga, gb, gd, ge, gf, gg, gh, gi, gl, gm, gn, gp, gq, gr, gs, gt, gu, gw, gy, hk, hm, hn, hr, ht, hu, id, ie, il, im, in, io, iq, ir, is, it, je, jm, jo, jp, ke, kg, kh, ki, km, kn, kp, kr, kw, ky, kz, la, lb, lc, li, lk, lr, ls, lt, lu, lv, ly, ma, mc, md, me, mf, mg, mh, mk, ml, mm, mn, mo, mp, mq, mr, ms, mt, mu, mv, mw, mx, my, mz, na, nc, ne, nf, ng, ni, nl, no, np, nr, nu, nz, om, pa, pe, pf, pg, ph, pk, pl, pm, pn, pr, ps, pt, pw, py, qa, qc, re, ro, rs, ru, rw, sa, sb, sc, sd, se, sg, sh, si, sj, sk, sl, sm, sn, so, sr, ss, st, sv, sx, sy, sz, tc, td, tf, tg, th, tj, tk, tl, tm, tn, to, tp, tr, tt, tv, tw, tz, ua, ug, uk, um, us, uy, uz, va, vc, ve, vg, vi, vn, vu, we, wf, ws, ye, yt, yu, za, zm, zw)
description	string	Custom description on your ip
iam	object	IAM resource metadata
ip	string (ip-block)	IP (v4 or v6) CIDR notation (e.g., 192.0.2.0/24) (example: 192.0.2.0/24)
is_additional_ip	boolean	Is this IP an Additional IP (alpha) (wire: isAdditionalIp)
regions	array	Where is the IP used/usable, in the form of region codenames (alpha)
rir	string	Regional Internet Registry of the IP (alpha)
routed_to	object	Routage information (wire: routedTo)
type	string	Possible values for ip type (cdn, cloud, dedicated, failover, hosted_ssl, housing, loadBalancing, mail, overthebox, pcc, pci, private, vpn, vps, vrack, xdsl)
version	integer	Version of the IP (alpha) (4, 6)

Methods

The following methods are available for this resource:

Name	Accessible by	Required Params	Optional Params	Description
get	select	ip		Get an IP. Returns the block's type, routed service, regions, RIR, organization, and BYOIP / Additional IP flags.
list	select		campus, description, iam_tags, ip, is_additional_ip, routed_to.service_name, type, version, x_pagination_mode	List IPs. Returns your IP blocks, filterable by routed service, type, version, campus, Additional IP or IAM tags.
update	update	ip		Update the IP description. Changes the block's free-text description, its only editable field. List IPs can filter on this description.
change_org	exec	ip, organisation		Change the organization. Sets the RIR organization (from /me/ipOrganisation) on the block's registry record (async task).
park	exec	ip		Park an IP. Detaches the IP from its service and keeps it on your account, unrouted. Returns the task that applies the change.

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	string (ip-block)
campus	string	Filter the value of campus property (ilike) (alpha)
description	string	Filter the value of description property (like)
iam_tags	object	Filter resources on IAM tags (wire: iamTags)
ip	string (ip-block)	Filter the value of ip property (contains or equals)
is_additional_ip	boolean	Filter the value of isAdditionalIp property (=) (alpha) (wire: isAdditionalIp)
routed_to.service_name	string	Filter the value of routedTo.serviceName property (like) (wire: routedTo.serviceName)
type	string	Filter the value of type property (=)
version	integer	Filter the value of version property (=) (alpha)
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. Returns the block's type, routed service, regions, RIR, organization, and BYOIP / Additional IP flags.

SELECT
organisation_id,
bring_your_own_ip,
campus,
can_be_terminated,
country,
description,
iam,
ip,
is_additional_ip,
regions,
rir,
routed_to,
type,
version
FROM ovh.ip.ips
WHERE ip = '{{ ip }}' -- required
;

list

List IPs. Returns your IP blocks, filterable by routed service, type, version, campus, Additional IP or IAM tags.

SELECT
organisation_id,
bring_your_own_ip,
campus,
can_be_terminated,
country,
description,
iam,
ip,
is_additional_ip,
regions,
rir,
routed_to,
type,
version
FROM ovh.ip.ips
WHERE campus = '{{ campus }}'
AND description = '{{ description }}'
AND iam_tags = '{{ iam_tags }}'
AND ip = '{{ ip }}'
AND is_additional_ip = '{{ is_additional_ip }}'
AND routed_to.service_name = '{{ routed_to.service_name }}'
AND type = '{{ type }}'
AND version = '{{ version }}'
AND x_pagination_mode = '{{ x_pagination_mode }}'
;

UPDATE examples

update

Update the IP description. Changes the block's free-text description, its only editable field. List IPs can filter on this description.

UPDATE ovh.ip.ips
SET 
description = '{{ description }}'
WHERE 
ip = '{{ ip }}' --required;

Lifecycle Methods

EXEC variables use wire (API) names.

change_org

Change the organization. Sets the RIR organization (from /me/ipOrganisation) on the block's registry record (async task).

EXEC ovh.ip.ips.change_org 
@ip='{{ ip }}' --required 
@@json=
'{
"organisation": "{{ organisation }}"
}'
;

park

Park an IP. Detaches the IP from its service and keeps it on your account, unrouted. Returns the task that applies the change.

EXEC ovh.ip.ips.park 
@ip='{{ ip }}' --required
;