Skip to content

Latest commit

 

History

History
113 lines (71 loc) · 4.87 KB

NetworkContextProfilesApi.md

File metadata and controls

113 lines (71 loc) · 4.87 KB
Raw

\NetworkContextProfilesApi

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

Method HTTP request Description
CreateNetworkContextProfile Post /1.0.0/networkContextProfiles Create a user-defined network context profile.
GetNetworkContextProfiles Get /1.0.0/networkContextProfiles Get all network context profiles.
SyncNetworkContextProfiles Post /1.0.0/networkContextProfiles/sync Sync the network context profiles from the network provider to VCD.

CreateNetworkContextProfile

CreateNetworkContextProfile(ctx, networkContextProfile) Create a user-defined network context profile.

Required Parameters

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

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]

GetNetworkContextProfiles

NetworkContextProfiles GetNetworkContextProfiles(ctx, page, pageSize, optional) Get all network context profiles.

Retrieves all network context profiles defined in the system. Supported contexts are:

  • Org vDC ID (_context==orgVdcId) - Returns all the network context profiles which are available to a specific Org vDC.
  • Network provider ID (_context==networkProviderId) - | Returns all the network context profiles which are available for a specific network provider.
  • VDC Group Id (_context==vdcGroupId) - | Returns all the network context profiles which are available to a specific vDC Group.

Required Parameters

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

Optional Parameters

Optional parameters are passed through a pointer to a NetworkContextProfilesApiGetNetworkContextProfilesOpts struct

Name Type Description Notes

filter | optional.String| Filter for a query. FIQL format. | sortAsc | optional.String| Field to use for ascending sort | sortDesc | optional.String| Field to use for descending sort |

Return type

NetworkContextProfiles

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]

SyncNetworkContextProfiles

SyncNetworkContextProfiles(ctx, optional) Sync the network context profiles from the network provider to VCD.

Sync the network context profiles from the network provider to VCD. The network provider is required to be specified in the filter context. Context example: (_context==networkProviderId).

Required Parameters

Name Type Description Notes
ctx context.Context context for authentication, logging, cancellation, deadlines, tracing, etc.
optional *NetworkContextProfilesApiSyncNetworkContextProfilesOpts optional parameters nil if no parameters

Optional Parameters

Optional parameters are passed through a pointer to a NetworkContextProfilesApiSyncNetworkContextProfilesOpts struct

Name Type Description Notes
filter optional.String Filter for a query. FIQL format.

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]