IpAddrGroup

Description

API


    POST /api/ipaddrgroup
    PUT /api/ipaddrgroup/<key>
    DELETE /api/ipaddrgroup/<key>
    GET /api/ipaddrgroup
    GET /api/ipaddrgroup/<key>

CLI


    configure ipaddrgroup <key>
    show ipaddrgroup <key>

Data

IpAddrGroup

uuid

Type: string
Category: required
Description: UUID of the IP address group

name

Type: string
Category: required
Description: Name of the IP address group

addrs

Type: IpAddr
Category: repeated
Description: Configure IP address(es)

ranges

Type: IpAddrRange
Category: repeated
Description: Configure IP address range(s)

prefixes

Type: IpAddrPrefix
Category: repeated
Description: Configure IP address prefix(es)

country_codes

Type: string
Category: repeated
Description: Populate the IP address ranges from the geo database for this country

apic_epg_name

Type: string
Category: optional
Description: Populate IP addresses from members of this Cisco APIC EPG

ip_ports

Type: IpAddrPort
Category: repeated
Description: Configure (IP address, port) tuple(s)

marathon_app_name

Type: string
Category: optional
Description: Populate IP addresses from tasks of this Marathon app

marathon_service_port

Type: uint32
Category: optional
Description: Task port associated with marathon service port. If Marathon app has multiple service ports, this is required. Else, the first task port is used

description

Type: string
Category: optional
Description

tenant_ref

Type: Reference to Tenant
Category: required
Description

IpAddr

addr

Type: string
Category: required
Description: IP address

type

Type: enum
Category: required
Description
Choices: V4, DNS

IpAddrRange

begin

Type: IpAddr
Category: required
Description: Starting IP address of the range

end

Type: IpAddr
Category: required
Description: Ending IP address of the range

IpAddrPrefix

ip_addr

Type: IpAddr
Category: required
Description

mask

Type: int32
Category: required
Description

IpAddrPort

ip

Type: IpAddr
Category: optional
Description: IP Address of host. One of IP address or hostname should be set

port

Type: uint32
Category: required
Description: Port number of server

hostname

Type: string
Category: optional
Description: Hostname of server. One of IP address or hostname should be set

name

Type: string
Category: optional
Description

References

Sub Objects