Get Sddc Template
Get configuration template for an SDDC
Request
URI
GET
https://vmc.vmware.com/vmc/api/orgs/{org}/sddcs/{sddc}/sddc-template
COPY
Path Parameters
string
org
Required
Organization identifier
string
sddc
Required
Sddc identifier
Responses
200
OK
Returns SddcTemplate of type(s) application/json
This response body class contains all of the following: AbstractEntity
{
"updated": "string",
"user_id": "string",
"updated_by_user_id": "string",
"created": "string",
"version": 5,
"updated_by_user_name": "string",
"user_name": "string",
"id": "1d1c83ee-e0b7-4de9-b660-9a9ca1d22f32",
"account_link_sddc_configs": [
{
"customer_subnet_ids": [
"string"
],
"connected_account_id": "string"
}
],
"state": "string",
"network_template": {
"management_gateway_templates": [
{
"public_ip": {
"public_ip": "string",
"name": "string",
"allocation_id": "string",
"dnat_rule_id": "string",
"associated_private_ip": "string",
"snat_rule_id": "string"
},
"primary_dns": "string",
"secondary_dns": "string",
"firewall_rules": [
{
"rule_type": "string",
"application_ids": [
"string"
],
"name": "string",
"rule_interface": "string",
"destination": "string",
"id": "string",
"destination_scope": {
"grouping_object_ids": [
"string"
],
"vnic_group_ids": [
"string"
]
},
"source": "string",
"source_scope": {
"grouping_object_ids": [
"string"
],
"vnic_group_ids": [
"string"
]
},
"services": [
{
"protocol": "string",
"ports": [
"string"
]
}
],
"action": "string",
"revision": 0
}
],
"vpns": [
{
"version": "string",
"on_prem_gateway_ip": "string",
"on_prem_network_cidr": "string",
"pfs_enabled": false,
"id": "string",
"channel_status": {
"channel_status": "string",
"channel_state": "string",
"last_info_message": "string",
"failure_message": "string"
},
"on_prem_nat_ip": "string",
"name": "string",
"internal_network_ids": [
"string"
],
"tunnel_statuses": [
{
"on_prem_subnet": "string",
"traffic_stats": {
"packets_out": "string",
"packet_received_errors": "string",
"rx_bytes_on_local_subnet": "string",
"replay_errors": "string",
"sequence_number_over_flow_errors": "string",
"encryption_failures": "string",
"integrity_errors": "string",
"packet_sent_errors": "string",
"decryption_failures": "string",
"packets_in": "string",
"tx_bytes_from_local_subnet": "string"
},
"last_info_message": "string",
"local_subnet": "string",
"tunnel_state": "string",
"failure_message": "string",
"tunnel_status": "string"
}
],
"encryption": "string",
"enabled": false,
"state": "string",
"dh_group": "string",
"authentication": "string",
"pre_shared_key": "string",
"ike_option": "string",
"digest_algorithm": "string"
}
],
"subnet_cidr": "string"
}
],
"compute_gateway_templates": [
{
"public_ip": {
"public_ip": "string",
"name": "string",
"allocation_id": "string",
"dnat_rule_id": "string",
"associated_private_ip": "string",
"snat_rule_id": "string"
},
"primary_dns": "string",
"secondary_dns": "string",
"firewall_rules": [
{
"rule_type": "string",
"application_ids": [
"string"
],
"name": "string",
"rule_interface": "string",
"destination": "string",
"id": "string",
"destination_scope": {
"grouping_object_ids": [
"string"
],
"vnic_group_ids": [
"string"
]
},
"source": "string",
"source_scope": {
"grouping_object_ids": [
"string"
],
"vnic_group_ids": [
"string"
]
},
"services": [
{
"protocol": "string",
"ports": [
"string"
]
}
],
"action": "string",
"revision": 0
}
],
"vpns": [
{
"version": "string",
"on_prem_gateway_ip": "string",
"on_prem_network_cidr": "string",
"pfs_enabled": false,
"id": "string",
"channel_status": {
"channel_status": "string",
"channel_state": "string",
"last_info_message": "string",
"failure_message": "string"
},
"on_prem_nat_ip": "string",
"name": "string",
"internal_network_ids": [
"string"
],
"tunnel_statuses": [
{
"on_prem_subnet": "string",
"traffic_stats": {
"packets_out": "string",
"packet_received_errors": "string",
"rx_bytes_on_local_subnet": "string",
"replay_errors": "string",
"sequence_number_over_flow_errors": "string",
"encryption_failures": "string",
"integrity_errors": "string",
"packet_sent_errors": "string",
"decryption_failures": "string",
"packets_in": "string",
"tx_bytes_from_local_subnet": "string"
},
"last_info_message": "string",
"local_subnet": "string",
"tunnel_state": "string",
"failure_message": "string",
"tunnel_status": "string"
}
],
"encryption": "string",
"enabled": false,
"state": "string",
"dh_group": "string",
"authentication": "string",
"pre_shared_key": "string",
"ike_option": "string",
"digest_algorithm": "string"
}
],
"logical_networks": [
{
"subnet_cidr": "string",
"name": "string",
"gatewayIp": "string",
"dhcp_enabled": "string",
"dhcp_ip_range": "string",
"tunnel_id": 0,
"id": "string",
"network_type": "string"
}
],
"nat_rules": [
{
"rule_type": "string",
"protocol": "string",
"name": "string",
"internal_ports": "string",
"public_ports": "string",
"public_ip": "string",
"internal_ip": "string",
"action": "string",
"id": "string",
"revision": 0
}
]
}
]
},
"name": "string",
"source_sddc_id": "string",
"org_id": "string",
"sddc": {
"name": "string",
"sddc_state": "string",
"expiration_date": "string",
"org_id": "string",
"sddc_type": "string",
"provider": "string",
"account_link_state": "string",
"sddc_access_state": "string",
"resource_config": {
"backup_restore_bucket": "string",
"public_ip_pool": [
{
"public_ip": "string",
"name": "string",
"allocation_id": "string",
"dnat_rule_id": "string",
"associated_private_ip": "string",
"snat_rule_id": "string"
}
],
"vpc_info": {
"esx_security_group_id": "string",
"vpc_cidr": "string",
"vgw_id": "string",
"esx_public_security_group_id": "string",
"vif_ids": [
"string"
],
"vm_security_group_id": "string",
"route_table_id": "string",
"edge_subnet_id": "string",
"id": "string",
"api_association_id": "string",
"api_subnet_id": "string",
"private_subnet_id": "string",
"private_association_id": "string",
"vcdr_enis": [
{
"secondary_ips": [
"string"
],
"attachment_id": "string",
"association_id": "string",
"vmk_id": "string",
"security_group_id": "string",
"instance_id": "string",
"subnet_id": "string",
"public_ips": [
"string"
],
"private_ip": "string",
"mac_address": "string",
"source_dest_check_false": false,
"portgroup": "string",
"id": "string"
}
],
"subnet_id": "string",
"internet_gateway_id": "string",
"security_group_id": "string",
"association_id": "string",
"vgw_route_table_id": "string",
"traffic_group_edge_vm_ips": [
"string"
],
"edge_association_id": "string",
"provider": "string",
"peering_connection_id": "string",
"network_type": "string",
"available_zones": [
{
"subnets": [
{
"subnet_id": "string",
"name": "string",
"route_tables": [
{
"subnet_id": "string",
"association_id": "string",
"routetable_id": "string"
}
]
}
],
"id": "string"
}
]
},
"kms_vpc_endpoint": {
"vpc_endpoint_id": "string",
"network_interface_ids": [
"string"
]
},
"max_num_public_ip": 0,
"esx_instance_profile": {
"role_name": "string",
"instance_profile_name": "string",
"policy_name": "string"
},
"account_link_sddc_config": [
{
"customer_subnet_ids": [
"string"
],
"connected_account_id": "string"
}
],
"vsan_encryption_config": {
"port": 0,
"certificate": "string"
},
"nsx_user_client": {
"redirect_uris": [
"string"
],
"accessTokenTTL": 0,
"redirect_uri": "string",
"grant_types": [
"string"
],
"org_id": "string",
"secret": "string",
"refreshTokenTTL": 0,
"resource_link": "string",
"id": "string"
},
"vpc_info_peered_agent": {
"esx_security_group_id": "string",
"vpc_cidr": "string",
"vgw_id": "string",
"esx_public_security_group_id": "string",
"vif_ids": [
"string"
],
"vm_security_group_id": "string",
"route_table_id": "string",
"edge_subnet_id": "string",
"id": "string",
"api_association_id": "string",
"api_subnet_id": "string",
"private_subnet_id": "string",
"private_association_id": "string",
"vcdr_enis": [
{
"secondary_ips": [
"string"
],
"attachment_id": "string",
"association_id": "string",
"vmk_id": "string",
"security_group_id": "string",
"instance_id": "string",
"subnet_id": "string",
"public_ips": [
"string"
],
"private_ip": "string",
"mac_address": "string",
"source_dest_check_false": false,
"portgroup": "string",
"id": "string"
}
],
"subnet_id": "string",
"internet_gateway_id": "string",
"security_group_id": "string",
"association_id": "string",
"vgw_route_table_id": "string",
"traffic_group_edge_vm_ips": [
"string"
],
"edge_association_id": "string",
"provider": "string",
"peering_connection_id": "string",
"network_type": "string",
"available_zones": [
{
"subnets": [
{
"subnet_id": "string",
"name": "string",
"route_tables": [
{
"subnet_id": "string",
"association_id": "string",
"routetable_id": "string"
}
]
}
],
"id": "string"
}
]
},
"nsx_service_client": {
"redirect_uris": [
"string"
],
"accessTokenTTL": 0,
"redirect_uri": "string",
"grant_types": [
"string"
],
"org_id": "string",
"secret": "string",
"refreshTokenTTL": 0,
"resource_link": "string",
"id": "string"
}
}
}
}
400
SDDC is in a state that cannot be use for generating configuration template
Operation doesn't return any data structure
401
Unauthorized
Operation doesn't return any data structure
403
Forbidden
Operation doesn't return any data structure
404
Cannot find the SDDC with given identifier
Returns ErrorResponse of type(s) application/json
{
"status": 0,
"path": "string",
"retryable": false,
"error_code": "string",
"error_messages": [
"string"
]
}integer
status
Required
HTTP status code
string
path
Required
Originating request URI
boolean
retryable
Required
If true, client should retry operation
string
error_code
Required
unique error code
array of string
error_messages
Required
localized error messages
Sddc Template Operations
DELETE
Delete Sddc Template
GET
Get Sddc Template
GET
Get Sddc Template
GET
List Sddc Templates