Skip to content

Latest commit

 

History

History
243 lines (154 loc) · 8.89 KB

OrgVdcNetworkDhcpApi.md

File metadata and controls

243 lines (154 loc) · 8.89 KB

\OrgVdcNetworkDhcpApi

All URIs are relative to https://localhost/cloudapi

Method HTTP request Description
CreateDhcpBinding Post /1.0.0/orgVdcNetworks/{vdcNetworkId}/dhcp/bindings Creates a DHCP binding on an Org vDC Network.
DeleteDhcpBinding Delete /1.0.0/orgVdcNetworks/{vdcNetworkId}/dhcp/bindings/{bindingId} Delete a specific DHCP binding of the Org vDC Network.
DeleteNetworkDhcpConfig Delete /1.0.0/orgVdcNetworks/{vdcNetworkId}/dhcp Removes Dhcp configuration on a specific Org vDC network.
GetDhcpBinding Get /1.0.0/orgVdcNetworks/{vdcNetworkId}/dhcp/bindings/{bindingId} Retrieve a specific DHCP binding of the Org vDC Network.
GetDhcpBindings Get /1.0.0/orgVdcNetworks/{vdcNetworkId}/dhcp/bindings Retrieves all DHCP bindings for an Org vDC Network.
GetNetworkDhcpConfig Get /1.0.0/orgVdcNetworks/{vdcNetworkId}/dhcp Retrieves Dhcp configuration of a specific Org vDC network.
UpdateDhcpBinding Put /1.0.0/orgVdcNetworks/{vdcNetworkId}/dhcp/bindings/{bindingId} Update a specific DHCP binding of the Org vDC Network.
UpdateNetworkDhcpConfig Put /1.0.0/orgVdcNetworks/{vdcNetworkId}/dhcp Updates Dhcp configuration of a specific Org vDC network.

CreateDhcpBinding

CreateDhcpBinding(ctx, dhcpBinding, vdcNetworkId) Creates a DHCP binding on an Org vDC Network.

Required Parameters

Name Type Description Notes
ctx context.Context context for authentication, logging, cancellation, deadlines, tracing, etc.
dhcpBinding DhcpBinding
vdcNetworkId string

Return type

(empty response body)

Authorization

ApiKeyAuth

HTTP request headers

  • Content-Type: application/json
  • Accept: /;version=36.0

[Back to top] [Back to API list] [Back to Model list] [Back to README]

DeleteDhcpBinding

DeleteDhcpBinding(ctx, vdcNetworkId, bindingId) Delete a specific DHCP binding of the Org vDC Network.

Required Parameters

Name Type Description Notes
ctx context.Context context for authentication, logging, cancellation, deadlines, tracing, etc.
vdcNetworkId string
bindingId string

Return type

(empty response body)

Authorization

ApiKeyAuth

HTTP request headers

  • Content-Type: Not defined
  • Accept: /;version=36.0

[Back to top] [Back to API list] [Back to Model list] [Back to README]

DeleteNetworkDhcpConfig

DeleteNetworkDhcpConfig(ctx, vdcNetworkId) Removes Dhcp configuration on a specific Org vDC network.

Required Parameters

Name Type Description Notes
ctx context.Context context for authentication, logging, cancellation, deadlines, tracing, etc.
vdcNetworkId string

Return type

(empty response body)

Authorization

ApiKeyAuth

HTTP request headers

  • Content-Type: Not defined
  • Accept: /;version=36.0

[Back to top] [Back to API list] [Back to Model list] [Back to README]

GetDhcpBinding

DhcpBinding GetDhcpBinding(ctx, vdcNetworkId, bindingId) Retrieve a specific DHCP binding of the Org vDC Network.

Required Parameters

Name Type Description Notes
ctx context.Context context for authentication, logging, cancellation, deadlines, tracing, etc.
vdcNetworkId string
bindingId string

Return type

DhcpBinding

Authorization

ApiKeyAuth

HTTP request headers

  • Content-Type: Not defined
  • Accept: application/json;version=36.0

[Back to top] [Back to API list] [Back to Model list] [Back to README]

GetDhcpBindings

DhcpBindings GetDhcpBindings(ctx, pageSize, vdcNetworkId, optional) Retrieves all DHCP bindings for an Org vDC Network.

Retrieves all DHCP bindings for an Org vDC Network.

Required Parameters

Name Type Description Notes
ctx context.Context context for authentication, logging, cancellation, deadlines, tracing, etc.
pageSize int32 Results per page to fetch. [default to 25]
vdcNetworkId string
optional *OrgVdcNetworkDhcpApiGetDhcpBindingsOpts optional parameters nil if no parameters

Optional Parameters

Optional parameters are passed through a pointer to a OrgVdcNetworkDhcpApiGetDhcpBindingsOpts struct

Name Type Description Notes

cursor | optional.String| Field used for getting next page of records. The value is supplied by the current result page. If not set, the first page is retrieved. If cursor is set, then all other pagination query parameters such as pageSize, sortDesc, sortAsc, queryFilter are ignored. |

Return type

DhcpBindings

Authorization

ApiKeyAuth

HTTP request headers

  • Content-Type: Not defined
  • Accept: application/json;version=36.0

[Back to top] [Back to API list] [Back to Model list] [Back to README]

GetNetworkDhcpConfig

VdcNetworkDhcpConfig GetNetworkDhcpConfig(ctx, vdcNetworkId) Retrieves Dhcp configuration of a specific Org vDC network.

Required Parameters

Name Type Description Notes
ctx context.Context context for authentication, logging, cancellation, deadlines, tracing, etc.
vdcNetworkId string

Return type

VdcNetworkDhcpConfig

Authorization

ApiKeyAuth

HTTP request headers

  • Content-Type: Not defined
  • Accept: application/json;version=36.0

[Back to top] [Back to API list] [Back to Model list] [Back to README]

UpdateDhcpBinding

UpdateDhcpBinding(ctx, dhcpBinding, vdcNetworkId, bindingId) Update a specific DHCP binding of the Org vDC Network.

Required Parameters

Name Type Description Notes
ctx context.Context context for authentication, logging, cancellation, deadlines, tracing, etc.
dhcpBinding DhcpBinding
vdcNetworkId string
bindingId string

Return type

(empty response body)

Authorization

ApiKeyAuth

HTTP request headers

  • Content-Type: application/json
  • Accept: /;version=36.0

[Back to top] [Back to API list] [Back to Model list] [Back to README]

UpdateNetworkDhcpConfig

UpdateNetworkDhcpConfig(ctx, dhcpConfig, vdcNetworkId) Updates Dhcp configuration of a specific Org vDC network.

Required Parameters

Name Type Description Notes
ctx context.Context context for authentication, logging, cancellation, deadlines, tracing, etc.
dhcpConfig VdcNetworkDhcpConfig
vdcNetworkId string

Return type

(empty response body)

Authorization

ApiKeyAuth

HTTP request headers

  • Content-Type: application/json
  • Accept: /;version=36.0

[Back to top] [Back to API list] [Back to Model list] [Back to README]