Skip to main content

Module ipam

Module ipam 

Source
Expand description

ipam endpoints. ipam endpoints for prefixes, addresses, vrfs, vlans, and asns.

includes availability queries for allocating IPs, prefixes, VLANs, and ASNs from their respective pools.

basic usage:

let prefixes = client.ipam().prefixes().list(None).await?;
println!("{}", prefixes.count);

availability queries:

// list available IPs in a prefix
let available = client.ipam().available_ips_in_prefix(42).await?;

// allocate from available pool
let created = client.ipam().create_available_ips_in_prefix(42, &[
    serde_json::json!({"description": "allocated via api"})
]).await?;

Structs§

CreateIpAddressRequest
request for creating a new IP address (id-based references).
CreatePrefixRequest
request for creating a new prefix (id-based references).
IpamApi
api for ipam endpoints
PatchIpAddressFieldsRequest
request for patching fields on an ip address.
PatchPrefixFieldsRequest
request for patching fields on a prefix.
UpdateIpAddressRequest
request for updating an IP address (id-based references).
UpdatePrefixRequest
request for updating a prefix (id-based references).

Type Aliases§

AggregatesApi
resource for aggregates.
Asn
ASN model.
AsnRangesApi
resource for ASN ranges.
AsnsApi
resource for ASNs.
AvailableAsn
available ASN model.
AvailableIp
available IP model.
AvailablePrefix
available prefix model.
AvailableVlan
available VLAN model.
FhrpGroupAssignmentsApi
resource for FHRP group assignments.
FhrpGroupsApi
resource for FHRP groups.
IpAddress
iP address model.
IpAddressesApi
resource for IP addresses.
IpRangesApi
resource for IP ranges.
Prefix
prefix model.
PrefixesApi
resource for prefixes.
RirsApi
resource for RIRs.
RolesApi
resource for roles.
RouteTargetsApi
resource for route targets.
ServiceTemplatesApi
resource for service templates.
ServicesApi
resource for services.
Vlan
VLAN model.
VlanGroupsApi
resource for VLAN groups.
VlanTranslationPoliciesApi
resource for VLAN translation policies.
VlanTranslationRulesApi
resource for VLAN translation rules.
VlansApi
resource for VLANs.
VrfsApi
resource for VRFs.