Get SDDC Configuation Template
Get configuration template for an SDDC
Request
URLURL
https://vmc.vmware.com/vmc/api/orgs/{org}/sddcs/{sddc}/sddc-template
Parameters
Parameters
string
org
Required
Organization identifier
string
sddc
Required
Sddc identifier
Response
Response
Response BodyResponse Body
200 OK returns
SddcTemplate
{
"account_link_sddc_configs": [
{
"connected_account_id": "string",
"customer_subnet_ids": [
"string"
]
}
],
"created": "string",
"id": "1d1c83ee-e0b7-4de9-b660-9a9ca1d22f32",
"name": "string",
"network_template": {
"compute_gateway_templates": [
{
"firewall_rules": [
{
"action": "string",
"application_ids": [
"string"
],
"destination": "string",
"destination_scope": {
"grouping_object_ids": [
"string"
],
"vnic_group_ids": [
"string"
]
},
"id": "string",
"name": "string",
"revision": 0,
"rule_interface": "string",
"rule_type": "string",
"services": [
{
"ports": [
"string"
],
"protocol": "string"
}
],
"source": "string",
"source_scope": {
"grouping_object_ids": [
"string"
],
"vnic_group_ids": [
"string"
]
}
}
],
"l2_vpn": [
{
"enabled": false,
"listener_ip": "string",
"sites": [
{
"dropped_rx_packets": "string",
"dropped_tx_packets": "string",
"established_date": "string",
"failure_message": "string",
"name": "string",
"password": "string",
"rx_bytes_on_local_subnet": 0,
"secure_traffic": false,
"tunnel_status": "string",
"tx_bytes_from_local_subnet": 0,
"user_id": "string"
}
]
}
],
"logical_networks": [
{
"dhcp_enabled": "string",
"dhcp_ip_range": "string",
"gatewayIp": "string",
"id": "string",
"name": "string",
"network_type": "string",
"subnet_cidr": "string",
"tunnel_id": 0
}
],
"nat_rules": [
{
"action": "string",
"id": "string",
"internal_ip": "string",
"internal_ports": "string",
"name": "string",
"protocol": "string",
"public_ip": "string",
"public_ports": "string",
"revision": 0,
"rule_type": "string"
}
],
"primary_dns": "string",
"public_ip": {
"allocation_id": "string",
"associated_private_ip": "string",
"dnat_rule_id": "string",
"name": "string",
"public_ip": "string",
"snat_rule_id": "string"
},
"secondary_dns": "string",
"vpns": [
{
"authentication": "string",
"channel_status": {
"channel_state": "string",
"channel_status": "string",
"failure_message": "string",
"last_info_message": "string"
},
"dh_group": "string",
"digest_algorithm": "string",
"enabled": false,
"encryption": "string",
"id": "string",
"ike_option": "string",
"internal_network_ids": [
"string"
],
"name": "string",
"on_prem_gateway_ip": "string",
"on_prem_nat_ip": "string",
"on_prem_network_cidr": "string",
"pfs_enabled": false,
"pre_shared_key": "string",
"state": "string",
"tunnel_statuses": [
{
"failure_message": "string",
"last_info_message": "string",
"local_subnet": "string",
"on_prem_subnet": "string",
"traffic_stats": {
"decryption_failures": "string",
"encryption_failures": "string",
"integrity_errors": "string",
"packet_received_errors": "string",
"packet_sent_errors": "string",
"packets_in": "string",
"packets_out": "string",
"replay_errors": "string",
"rx_bytes_on_local_subnet": "string",
"sequence_number_over_flow_errors": "string",
"tx_bytes_from_local_subnet": "string"
},
"tunnel_state": "string",
"tunnel_status": "string"
}
],
"version": "string"
}
]
}
],
"management_gateway_templates": [
{
"firewall_rules": [
{
"action": "string",
"application_ids": [
"string"
],
"destination": "string",
"destination_scope": {
"grouping_object_ids": [
"string"
],
"vnic_group_ids": [
"string"
]
},
"id": "string",
"name": "string",
"revision": 0,
"rule_interface": "string",
"rule_type": "string",
"services": [
{
"ports": [
"string"
],
"protocol": "string"
}
],
"source": "string",
"source_scope": {
"grouping_object_ids": [
"string"
],
"vnic_group_ids": [
"string"
]
}
}
],
"primary_dns": "string",
"public_ip": {
"allocation_id": "string",
"associated_private_ip": "string",
"dnat_rule_id": "string",
"name": "string",
"public_ip": "string",
"snat_rule_id": "string"
},
"secondary_dns": "string",
"subnet_cidr": "string",
"vpns": [
{
"authentication": "string",
"channel_status": {
"channel_state": "string",
"channel_status": "string",
"failure_message": "string",
"last_info_message": "string"
},
"dh_group": "string",
"digest_algorithm": "string",
"enabled": false,
"encryption": "string",
"id": "string",
"ike_option": "string",
"internal_network_ids": [
"string"
],
"name": "string",
"on_prem_gateway_ip": "string",
"on_prem_nat_ip": "string",
"on_prem_network_cidr": "string",
"pfs_enabled": false,
"pre_shared_key": "string",
"state": "string",
"tunnel_statuses": [
{
"failure_message": "string",
"last_info_message": "string",
"local_subnet": "string",
"on_prem_subnet": "string",
"traffic_stats": {
"decryption_failures": "string",
"encryption_failures": "string",
"integrity_errors": "string",
"packet_received_errors": "string",
"packet_sent_errors": "string",
"packets_in": "string",
"packets_out": "string",
"replay_errors": "string",
"rx_bytes_on_local_subnet": "string",
"sequence_number_over_flow_errors": "string",
"tx_bytes_from_local_subnet": "string"
},
"tunnel_state": "string",
"tunnel_status": "string"
}
],
"version": "string"
}
]
}
]
},
"org_id": "string",
"sddc": {
"account_link_state": "string",
"created": "string",
"expiration_date": "string",
"id": "1d1c83ee-e0b7-4de9-b660-9a9ca1d22f32",
"name": "string",
"org_id": "string",
"provider": "string",
"resource_config": {
"account_link_sddc_config": [
{
"connected_account_id": "string",
"customer_subnet_ids": [
"string"
]
}
],
"availability_zones": [
"string"
],
"backup_restore_bucket": "string",
"cgws": [
"string"
],
"cloud_password": "string",
"cloud_user_group": "string",
"cloud_username": "string",
"clusters": [
{
"aws_kms_info": {
"amazon_resource_name": "string"
},
"cluster_capacity": {
"cpu_capacity_ghz": 0,
"memory_capacity_gib": 0,
"number_of_sockets": 0,
"number_of_ssds": 0,
"storage_capacity_gib": 0,
"total_number_of_cores": 0
},
"cluster_id": "string",
"cluster_name": "string",
"cluster_state": "string",
"esx_host_info": {
"instance_type": "string"
},
"esx_host_list": [
{
"availability_zone": "string",
"custom_properties": {
"key": "string"
},
"esx_id": "string",
"esx_state": "string",
"hostname": "string",
"instance_type": "string",
"internal_public_ip_pool": [
{
"allocation_id": "string",
"associated_private_ip": "string",
"dnat_rule_id": "string",
"name": "string",
"public_ip": "string",
"snat_rule_id": "string"
}
],
"mac_address": "string",
"name": "string",
"provider": "string"
}
],
"host_cpu_cores_count": 0,
"msft_license_config": {
"mssql_licensing": "string",
"windows_licensing": "string"
}
}
],
"custom_properties": {
"key": "string"
},
"deployment_type": "string",
"dns_with_management_vm_private_ip": false,
"esx_cluster_id": "string",
"esx_host_subnet": "string",
"esx_hosts": [
{
"availability_zone": "string",
"custom_properties": {
"key": "string"
},
"esx_id": "string",
"esx_state": "string",
"hostname": "string",
"instance_type": "string",
"internal_public_ip_pool": [
{
"allocation_id": "string",
"associated_private_ip": "string",
"dnat_rule_id": "string",
"name": "string",
"public_ip": "string",
"snat_rule_id": "string"
}
],
"mac_address": "string",
"name": "string",
"provider": "string"
}
],
"kms_vpc_endpoint": {
"network_interface_ids": [
"string"
],
"vpc_endpoint_id": "string"
},
"management_ds": "string",
"management_rp": "string",
"max_num_public_ip": 0,
"mgmt_appliance_network_name": "string",
"mgw_id": "string",
"msft_license_config": {
"mssql_licensing": "string",
"windows_licensing": "string"
},
"nsx_api_public_endpoint_url": "string",
"nsx_controller_ips": [
"string"
],
"nsx_mgr_management_ip": "string",
"nsx_mgr_url": "string",
"nsxt": false,
"nsxt_addons": {
"enable_nsx_advanced_addon": false
},
"pop_agent_xeni_connection": {
"default_subnet_route": "string",
"eni_info": {
"id": "string",
"mac_address": "string",
"private_ip": "string",
"security_group_id": "string",
"subnet_id": "string"
}
},
"provider": "string",
"psc_management_ip": "string",
"psc_url": "string",
"public_ip_pool": [
{
"allocation_id": "string",
"associated_private_ip": "string",
"dnat_rule_id": "string",
"name": "string",
"public_ip": "string",
"snat_rule_id": "string"
}
],
"region": "string",
"sddc_id": "string",
"sddc_manifest": {
"ebs_backed_vsan_config": {
"instance_type": "string"
},
"esx_ami": {
"id": "string",
"instance_type": "string",
"name": "string",
"region": "string"
},
"esx_nsxt_ami": {
"id": "string",
"instance_type": "string",
"name": "string",
"region": "string"
},
"glcm_bundle": {
"id": "string",
"s3Bucket": "string"
},
"metadata": {
"cycle_id": "string",
"timestamp": "string"
},
"pop_info": {
"ami_infos": {
"key": {
"id": "string",
"instance_type": "string",
"name": "string",
"region": "string",
"type": "string"
}
},
"created_at": "string",
"id": "string",
"manifest_version": "string",
"service_infos": {
"key": {
"build": "string",
"cln": "string",
"service": "string",
"version": "string"
}
}
},
"vmc_internal_version": "string",
"vmc_version": "string",
"vsan_witness_ami": {
"id": "string",
"instance_type": "string",
"name": "string",
"region": "string"
}
},
"sddc_networks": [
"string"
],
"sddc_size": {
"nsx_size": "string",
"size": "string",
"vc_size": "string"
},
"skip_creating_vxlan": false,
"sso_domain": "string",
"vc_instance_id": "string",
"vc_management_ip": "string",
"vc_public_ip": "string",
"vc_url": "string",
"vpc_info": {
"api_association_id": "string",
"api_subnet_id": "string",
"association_id": "string",
"available_zones": [
{
"name": "string",
"subnets": [
{
"name": "string",
"route_tables": [
{
"association_id": "string",
"routetable_id": "string",
"subnet_id": "string"
}
],
"subnet_id": "string"
}
]
}
],
"edge_association_id": "string",
"edge_subnet_id": "string",
"esx_public_security_group_id": "string",
"esx_security_group_id": "string",
"id": "string",
"internet_gateway_id": "string",
"network_type": "string",
"peering_connection_id": "string",
"private_association_id": "string",
"private_subnet_id": "string",
"provider": "string",
"route_table_id": "string",
"routetables": {
"key": {
"id": "string",
"name": "string"
}
},
"security_group_id": "string",
"subnet_id": "string",
"tgwIps": {
"key": "string"
},
"trafficGroupEdgeVmIps": [
"string"
],
"vgw_id": "string",
"vgw_route_table_id": "string",
"vif_ids": [
"string"
],
"vm_security_group_id": "string",
"vpc_cidr": "string"
},
"vpc_info_peered_agent": {
"api_association_id": "string",
"api_subnet_id": "string",
"association_id": "string",
"available_zones": [
{
"name": "string",
"subnets": [
{
"name": "string",
"route_tables": [
{
"association_id": "string",
"routetable_id": "string",
"subnet_id": "string"
}
],
"subnet_id": "string"
}
]
}
],
"edge_association_id": "string",
"edge_subnet_id": "string",
"esx_public_security_group_id": "string",
"esx_security_group_id": "string",
"id": "string",
"internet_gateway_id": "string",
"network_type": "string",
"peering_connection_id": "string",
"private_association_id": "string",
"private_subnet_id": "string",
"provider": "string",
"route_table_id": "string",
"routetables": {
"key": {
"id": "string",
"name": "string"
}
},
"security_group_id": "string",
"subnet_id": "string",
"tgwIps": {
"key": "string"
},
"trafficGroupEdgeVmIps": [
"string"
],
"vgw_id": "string",
"vgw_route_table_id": "string",
"vif_ids": [
"string"
],
"vm_security_group_id": "string",
"vpc_cidr": "string"
},
"vsan_encryption_config": {
"certificate": "string",
"port": 0
},
"vxlan_subnet": "string",
"witness_availability_zone": "string"
},
"sddc_access_state": "string",
"sddc_state": "string",
"sddc_type": "string",
"updated": "string",
"updated_by_user_id": "string",
"updated_by_user_name": "string",
"user_id": "string",
"user_name": "string",
"version": 5
},
"source_sddc_id": "string",
"state": "string",
"updated": "string",
"updated_by_user_id": "string",
"updated_by_user_name": "string",
"user_id": "string",
"user_name": "string",
"version": 5
}
string
created
Required
Not available
string
id
Required
Unique ID for this entity
string
name
Required
name for SDDC configuration template
string
state
Required
Not available
Possible values are: INITIALIZATION, AVAILABLE, INUSE, APPLIED, DELETING, DELETED, FAILED
string
updated
Required
Not available
string
updated_by_user_id
Required
User id that last updated this record
string
user_id
Required
User id that last updated this record
string
user_name
Required
User name that last updated this record
integer
version
Required
Version of this entity
array of
AccountLinkSddcConfig
account_link_sddc_configs
Optional
A list of the SDDC linking configurations to use.
string
org_id
Optional
Not available
string
source_sddc_id
Optional
Not available
string
updated_by_user_name
Optional
User name that last updated this record
cURL Command
curl https://vmc.vmware.com/vmc/api/orgs/{org}/sddcs/{sddc}/sddc-template
Errors
404
The requested resource could not be found but may be available again in the future.
Not available
400
The request cannot be fulfilled due to bad syntax.
Not available
401
The request requires user authentication.
Not available
403
The server understood the request, but is refusing to fulfill it.