Ctrl K

Delete fixed address

Published today

Delete a static DHCP reservation, identified by its _ref or by its MAC address (optionally narrowed by network_view). Fails without deleting anything when the MAC matches zero or several reservations. Returns the _ref of the deleted reservation.

Script infoblox_nios Verified

Use in Windmill

The script

Submitted by hugo989 Typescript (fetch-only)

Verified 6 hours ago

All edits

Permalink

//native

function wapiUrl(auth: RT.InfobloxNios, path: string) {
  const host = auth.host
    .trim()
    .replace(/^https?:\/\//, "")
    .replace(/\/+$/, "")
  const version = auth.wapi_version.trim().replace(/^v/, "")
  return new URL(`https://${host}/wapi/v${version}/${path}`)
}

function refUrl(auth: RT.InfobloxNios, ref: string, type: string) {
  // Encode each segment so ?, # or .. in a ref can't reach another path or query.
  const segments = ref.split("/")
  if (
    segments[0] !== type ||
    segments.length < 2 ||
    segments.some((s) => s === "." || s === "..")
  ) {
    throw new Error(`Expected a ${type} reference, got: ${ref}`)
  }
  return wapiUrl(
    auth,
    segments.map((s) => encodeURIComponent(s).replace(/%3A/gi, ":")).join("/")
  )
}

function basicAuth(auth: RT.InfobloxNios) {
  const bytes = new TextEncoder().encode(`${auth.username}:${auth.password}`)
  return `Basic ${btoa(String.fromCharCode(...bytes))}`
}

/**
 * Delete fixed address
 * Delete a static DHCP reservation, identified by its _ref or by its MAC address (optionally narrowed by network_view). Fails without deleting anything when the MAC matches zero or several reservations. Returns the _ref of the deleted reservation.
 */
export async function main(
  auth: RT.InfobloxNios,
  ref: string | undefined,
  mac: string | undefined,
  network_view: string | undefined
) {
  if (!ref === !mac) {
    throw new Error("Set exactly one of ref or mac")
  }

  let target = ref
  if (!target) {
    const lookup = wapiUrl(auth, "fixedaddress")
    lookup.searchParams.append("mac", mac!)
    if (network_view) lookup.searchParams.append("network_view", network_view)
    lookup.searchParams.append("_return_as_object", "1")

    const lookupResponse = await fetch(lookup, {
      headers: {
        Authorization: basicAuth(auth),
        Accept: "application/json",
      },
    })
    if (!lookupResponse.ok) {
      throw new Error(`${lookupResponse.status} ${await lookupResponse.text()}`)
    }
    const { result } = (await lookupResponse.json()) as {
      result: { _ref: string; ipv4addr: string; network_view: string }[]
    }
    if (result.length === 0) {
      throw new Error(`No fixed address found for MAC ${mac}`)
    }
    if (result.length > 1) {
      throw new Error(
        `MAC ${mac} matches ${result.length} fixed addresses; pass the ref of one: ${result.map((r) => r._ref).join(", ")}`
      )
    }
    target = result[0]._ref
  }

  const url = refUrl(auth, target!, "fixedaddress")
  url.searchParams.append("_return_as_object", "1")

  const response = await fetch(url, {
    method: "DELETE",
    headers: {
      Authorization: basicAuth(auth),
      Accept: "application/json",
    },
  })

  if (!response.ok) {
    throw new Error(`${response.status} ${await response.text()}`)
  }

  return await response.json()
}


`1`	`//native`
`2`
`3`	`function wapiUrl(auth: RT.InfobloxNios, path: string) {`
`4`	`const host = auth.host`
`5`	`.trim()`
`6`	`.replace(/^https?:\/\//, "")`
`7`	`.replace(/\/+$/, "")`
`8`	`const version = auth.wapi_version.trim().replace(/^v/, "")`
`9`	return new URL(`https://${host}/wapi/v${version}/${path}`)
`10`	`}`
`11`
`12`	`function refUrl(auth: RT.InfobloxNios, ref: string, type: string) {`
`13`	`// Encode each segment so ?, # or .. in a ref can't reach another path or query.`
`14`	`const segments = ref.split("/")`
`15`	`if (`
`16`	`segments[0] !== type \|\|`
`17`	`segments.length < 2 \|\|`
`18`	`segments.some((s) => s === "." \|\| s === "..")`
`19`	`) {`
`20`	throw new Error(`Expected a ${type} reference, got: ${ref}`)
`21`	`}`
`22`	`return wapiUrl(`
`23`	`auth,`
`24`	`segments.map((s) => encodeURIComponent(s).replace(/%3A/gi, ":")).join("/")`
`25`	`)`
`26`	`}`
`27`
`28`	`function basicAuth(auth: RT.InfobloxNios) {`
`29`	const bytes = new TextEncoder().encode(`${auth.username}:${auth.password}`)
`30`	return `Basic ${btoa(String.fromCharCode(...bytes))}`
`31`	`}`
`32`
`33`	`/**`
`34`	`* Delete fixed address`
`35`	`* Delete a static DHCP reservation, identified by its _ref or by its MAC address (optionally narrowed by network_view). Fails without deleting anything when the MAC matches zero or several reservations. Returns the _ref of the deleted reservation.`
`36`	`*/`
`37`	`export async function main(`
`38`	`auth: RT.InfobloxNios,`
`39`	`ref: string \| undefined,`
`40`	`mac: string \| undefined,`
`41`	`network_view: string \| undefined`
`42`	`) {`
`43`	`if (!ref === !mac) {`
`44`	`throw new Error("Set exactly one of ref or mac")`
`45`	`}`
`46`
`47`	`let target = ref`
`48`	`if (!target) {`
`49`	`const lookup = wapiUrl(auth, "fixedaddress")`
`50`	`lookup.searchParams.append("mac", mac!)`
`51`	`if (network_view) lookup.searchParams.append("network_view", network_view)`
`52`	`lookup.searchParams.append("_return_as_object", "1")`
`53`
`54`	`const lookupResponse = await fetch(lookup, {`
`55`	`headers: {`
`56`	`Authorization: basicAuth(auth),`
`57`	`Accept: "application/json",`
`58`	`},`
`59`	`})`
`60`	`if (!lookupResponse.ok) {`
`61`	throw new Error(`${lookupResponse.status} ${await lookupResponse.text()}`)
`62`	`}`
`63`	`const { result } = (await lookupResponse.json()) as {`
`64`	`result: { _ref: string; ipv4addr: string; network_view: string }[]`
`65`	`}`
`66`	`if (result.length === 0) {`
`67`	throw new Error(`No fixed address found for MAC ${mac}`)
`68`	`}`
`69`	`if (result.length > 1) {`
`70`	`throw new Error(`
`71`	`MAC ${mac} matches ${result.length} fixed addresses; pass the ref of one: ${result.map((r) => r._ref).join(", ")}`
`72`	`)`
`73`	`}`
`74`	`target = result[0]._ref`
`75`	`}`
`76`
`77`	`const url = refUrl(auth, target!, "fixedaddress")`
`78`	`url.searchParams.append("_return_as_object", "1")`
`79`
`80`	`const response = await fetch(url, {`
`81`	`method: "DELETE",`
`82`	`headers: {`
`83`	`Authorization: basicAuth(auth),`
`84`	`Accept: "application/json",`
`85`	`},`
`86`	`})`
`87`
`88`	`if (!response.ok) {`
`89`	throw new Error(`${response.status} ${await response.text()}`)
`90`	`}`
`91`
`92`	`return await response.json()`
`93`	`}`
`94`