POST - Create a multicast subnet in a cluster

Purpose

This API call is designed to create a multicast subnet in a cluster within a Windows cluster environment.

Request URL 

Method: POST

https://{appconsole_IP}:{9443}/api/dhcp/subnet_data/

Request Headers

The following headers must be included in the API request for successful authentication and data submission:

Authorization: DDI Central's OAuth implementation uses the Bearer authentication scheme. Hence, while making API calls, access_token obtained via the OAuth 2.0 Client Credentials Grant must be included in the Authorization header of API requests. This token verifies the client’s identity and ensures appropriate permissions for accessing resources.

The Authorization Header follows the format below:

headers = { "Authorization": "Bearer {bearer_tk}" }


Content-Type: Required in the header to indicate the media type of the resource being sent. It helps the server at the receiving end understand how to process the transmitted request body.

The Content-Type Header follows the format below:

headers ={ "Content-Type": "application/json" }

Request Body

  • subnet_ip*  string
    •  Specifies the IP ranges for the subnets that are part of the network configuration.
  • cluster_name*  int
    •  Specifies the name of the cluster for which this network configuration is defined.
  • dhcp_type*  string
    •  Indicates the type of DHCP service being used to assign IP addresses to devices within the network.
  • network_address*  string
    •  Represents the base network address for the entire network. This serves as the foundation for subnetting within the configuration.
  • prefix*  string
    •  Defines the subnet mask for the base network address in CIDR notation.
  • static_subnet_ip*  string
    •  Lists subnets reserved for static IP allocation.

 

* - Mandatory parameter.

 

 

Sample Request

Copied
Copied{
   "cluster_name":"local-cluster",
   "network_address":"224.2.3.0",
   "dhcp_server_address":"192.168.220.172",
   "prefix":24,
   "scope_name":"multicastsubnet",
   "dhcp_type":"dhcpd",
   "range":{
      "start":"224.2.3.1",
      "end":"224.2.3.56"
   },
   "is_multicast_scope":true,
   "ttl":32
}

Sample Response

Copied
Copied{
   "id":5528,
   "network_address":"224.2.3.0",
   "dhcp_type":"dhcpd",
   "prefix":24,
   "subnet_description":null,
   "netmask":"255.255.255.0",
   "range":{
      "start":"224.2.3.1",
      "end":"224.2.3.56"
   },
   "scope_name":"multicastsubnet",
   "state":"Active",
   "lease_duration":"8.00:00:00",
   "is_multicast_scope":true,
   "cluster_name":"local-cluster",
   "dhcp_server_address":"192.168.220.172"
}