vcd.NetworkDirect
Explore with Pulumi AI
Create NetworkDirect Resource
Resources are created with functions called constructors. To learn more about declaring and configuring resources, see Resources.
Constructor syntax
new NetworkDirect(name: string, args: NetworkDirectArgs, opts?: CustomResourceOptions);
@overload
def NetworkDirect(resource_name: str,
args: NetworkDirectArgs,
opts: Optional[ResourceOptions] = None)
@overload
def NetworkDirect(resource_name: str,
opts: Optional[ResourceOptions] = None,
external_network: Optional[str] = None,
description: Optional[str] = None,
metadata: Optional[Mapping[str, str]] = None,
metadata_entries: Optional[Sequence[NetworkDirectMetadataEntryArgs]] = None,
name: Optional[str] = None,
network_direct_id: Optional[str] = None,
org: Optional[str] = None,
shared: Optional[bool] = None,
vdc: Optional[str] = None)
func NewNetworkDirect(ctx *Context, name string, args NetworkDirectArgs, opts ...ResourceOption) (*NetworkDirect, error)
public NetworkDirect(string name, NetworkDirectArgs args, CustomResourceOptions? opts = null)
public NetworkDirect(String name, NetworkDirectArgs args)
public NetworkDirect(String name, NetworkDirectArgs args, CustomResourceOptions options)
type: vcd:NetworkDirect
properties: # The arguments to resource properties.
options: # Bag of options to control resource's behavior.
Parameters
- name string
- The unique name of the resource.
- args NetworkDirectArgs
- The arguments to resource properties.
- opts CustomResourceOptions
- Bag of options to control resource's behavior.
- resource_name str
- The unique name of the resource.
- args NetworkDirectArgs
- The arguments to resource properties.
- opts ResourceOptions
- Bag of options to control resource's behavior.
- ctx Context
- Context object for the current deployment.
- name string
- The unique name of the resource.
- args NetworkDirectArgs
- The arguments to resource properties.
- opts ResourceOption
- Bag of options to control resource's behavior.
- name string
- The unique name of the resource.
- args NetworkDirectArgs
- The arguments to resource properties.
- opts CustomResourceOptions
- Bag of options to control resource's behavior.
- name String
- The unique name of the resource.
- args NetworkDirectArgs
- The arguments to resource properties.
- options CustomResourceOptions
- Bag of options to control resource's behavior.
Constructor example
The following reference example uses placeholder values for all input properties.
var networkDirectResource = new Vcd.NetworkDirect("networkDirectResource", new()
{
ExternalNetwork = "string",
Description = "string",
MetadataEntries = new[]
{
new Vcd.Inputs.NetworkDirectMetadataEntryArgs
{
IsSystem = false,
Key = "string",
Type = "string",
UserAccess = "string",
Value = "string",
},
},
Name = "string",
NetworkDirectId = "string",
Org = "string",
Shared = false,
Vdc = "string",
});
example, err := vcd.NewNetworkDirect(ctx, "networkDirectResource", &vcd.NetworkDirectArgs{
ExternalNetwork: pulumi.String("string"),
Description: pulumi.String("string"),
MetadataEntries: vcd.NetworkDirectMetadataEntryArray{
&vcd.NetworkDirectMetadataEntryArgs{
IsSystem: pulumi.Bool(false),
Key: pulumi.String("string"),
Type: pulumi.String("string"),
UserAccess: pulumi.String("string"),
Value: pulumi.String("string"),
},
},
Name: pulumi.String("string"),
NetworkDirectId: pulumi.String("string"),
Org: pulumi.String("string"),
Shared: pulumi.Bool(false),
Vdc: pulumi.String("string"),
})
var networkDirectResource = new NetworkDirect("networkDirectResource", NetworkDirectArgs.builder()
.externalNetwork("string")
.description("string")
.metadataEntries(NetworkDirectMetadataEntryArgs.builder()
.isSystem(false)
.key("string")
.type("string")
.userAccess("string")
.value("string")
.build())
.name("string")
.networkDirectId("string")
.org("string")
.shared(false)
.vdc("string")
.build());
network_direct_resource = vcd.NetworkDirect("networkDirectResource",
external_network="string",
description="string",
metadata_entries=[{
"is_system": False,
"key": "string",
"type": "string",
"user_access": "string",
"value": "string",
}],
name="string",
network_direct_id="string",
org="string",
shared=False,
vdc="string")
const networkDirectResource = new vcd.NetworkDirect("networkDirectResource", {
externalNetwork: "string",
description: "string",
metadataEntries: [{
isSystem: false,
key: "string",
type: "string",
userAccess: "string",
value: "string",
}],
name: "string",
networkDirectId: "string",
org: "string",
shared: false,
vdc: "string",
});
type: vcd:NetworkDirect
properties:
description: string
externalNetwork: string
metadataEntries:
- isSystem: false
key: string
type: string
userAccess: string
value: string
name: string
networkDirectId: string
org: string
shared: false
vdc: string
NetworkDirect Resource Properties
To learn more about resource properties and how to use them, see Inputs and Outputs in the Architecture and Concepts docs.
Inputs
In Python, inputs that are objects can be passed either as argument classes or as dictionary literals.
The NetworkDirect resource accepts the following input properties:
- External
Network string - The name of the external network.
- Description string
- An optional description of the network
- Metadata Dictionary<string, string>
- Use
metadata_entry
instead. Key value map of metadata to assign to this network. - Metadata
Entries List<NetworkDirect Metadata Entry> - A set of metadata entries to assign. See Metadata section for details.
- Name string
- A unique name for the network
- Network
Direct stringId - Org string
- The name of organization to use, optional if defined at provider level. Useful when connected as sysadmin working across different organisations
- bool
- Defines if this network is shared between multiple VDCs
in the Org. Defaults to
false
. - Vdc string
- The name of VDC to use, optional if defined at provider level
- External
Network string - The name of the external network.
- Description string
- An optional description of the network
- Metadata map[string]string
- Use
metadata_entry
instead. Key value map of metadata to assign to this network. - Metadata
Entries []NetworkDirect Metadata Entry Args - A set of metadata entries to assign. See Metadata section for details.
- Name string
- A unique name for the network
- Network
Direct stringId - Org string
- The name of organization to use, optional if defined at provider level. Useful when connected as sysadmin working across different organisations
- bool
- Defines if this network is shared between multiple VDCs
in the Org. Defaults to
false
. - Vdc string
- The name of VDC to use, optional if defined at provider level
- external
Network String - The name of the external network.
- description String
- An optional description of the network
- metadata Map<String,String>
- Use
metadata_entry
instead. Key value map of metadata to assign to this network. - metadata
Entries List<NetworkDirect Metadata Entry> - A set of metadata entries to assign. See Metadata section for details.
- name String
- A unique name for the network
- network
Direct StringId - org String
- The name of organization to use, optional if defined at provider level. Useful when connected as sysadmin working across different organisations
- Boolean
- Defines if this network is shared between multiple VDCs
in the Org. Defaults to
false
. - vdc String
- The name of VDC to use, optional if defined at provider level
- external
Network string - The name of the external network.
- description string
- An optional description of the network
- metadata {[key: string]: string}
- Use
metadata_entry
instead. Key value map of metadata to assign to this network. - metadata
Entries NetworkDirect Metadata Entry[] - A set of metadata entries to assign. See Metadata section for details.
- name string
- A unique name for the network
- network
Direct stringId - org string
- The name of organization to use, optional if defined at provider level. Useful when connected as sysadmin working across different organisations
- boolean
- Defines if this network is shared between multiple VDCs
in the Org. Defaults to
false
. - vdc string
- The name of VDC to use, optional if defined at provider level
- external_
network str - The name of the external network.
- description str
- An optional description of the network
- metadata Mapping[str, str]
- Use
metadata_entry
instead. Key value map of metadata to assign to this network. - metadata_
entries Sequence[NetworkDirect Metadata Entry Args] - A set of metadata entries to assign. See Metadata section for details.
- name str
- A unique name for the network
- network_
direct_ strid - org str
- The name of organization to use, optional if defined at provider level. Useful when connected as sysadmin working across different organisations
- bool
- Defines if this network is shared between multiple VDCs
in the Org. Defaults to
false
. - vdc str
- The name of VDC to use, optional if defined at provider level
- external
Network String - The name of the external network.
- description String
- An optional description of the network
- metadata Map<String>
- Use
metadata_entry
instead. Key value map of metadata to assign to this network. - metadata
Entries List<Property Map> - A set of metadata entries to assign. See Metadata section for details.
- name String
- A unique name for the network
- network
Direct StringId - org String
- The name of organization to use, optional if defined at provider level. Useful when connected as sysadmin working across different organisations
- Boolean
- Defines if this network is shared between multiple VDCs
in the Org. Defaults to
false
. - vdc String
- The name of VDC to use, optional if defined at provider level
Outputs
All input properties are implicitly available as output properties. Additionally, the NetworkDirect resource produces the following output properties:
- External
Network stringDns1 - (Computed) returns the first DNS from the external network
- External
Network stringDns2 - (Computed) returns the second DNS from the external network
- External
Network stringDns Suffix - (Computed) returns the DNS suffix from the external network
- External
Network stringGateway - (Computed) returns the gateway from the external network
- External
Network stringNetmask - (Computed) returns the netmask from the external network
- Href string
- Network Hypertext Reference
- Id string
- The provider-assigned unique ID for this managed resource.
- External
Network stringDns1 - (Computed) returns the first DNS from the external network
- External
Network stringDns2 - (Computed) returns the second DNS from the external network
- External
Network stringDns Suffix - (Computed) returns the DNS suffix from the external network
- External
Network stringGateway - (Computed) returns the gateway from the external network
- External
Network stringNetmask - (Computed) returns the netmask from the external network
- Href string
- Network Hypertext Reference
- Id string
- The provider-assigned unique ID for this managed resource.
- external
Network StringDns1 - (Computed) returns the first DNS from the external network
- external
Network StringDns2 - (Computed) returns the second DNS from the external network
- external
Network StringDns Suffix - (Computed) returns the DNS suffix from the external network
- external
Network StringGateway - (Computed) returns the gateway from the external network
- external
Network StringNetmask - (Computed) returns the netmask from the external network
- href String
- Network Hypertext Reference
- id String
- The provider-assigned unique ID for this managed resource.
- external
Network stringDns1 - (Computed) returns the first DNS from the external network
- external
Network stringDns2 - (Computed) returns the second DNS from the external network
- external
Network stringDns Suffix - (Computed) returns the DNS suffix from the external network
- external
Network stringGateway - (Computed) returns the gateway from the external network
- external
Network stringNetmask - (Computed) returns the netmask from the external network
- href string
- Network Hypertext Reference
- id string
- The provider-assigned unique ID for this managed resource.
- external_
network_ strdns1 - (Computed) returns the first DNS from the external network
- external_
network_ strdns2 - (Computed) returns the second DNS from the external network
- external_
network_ strdns_ suffix - (Computed) returns the DNS suffix from the external network
- external_
network_ strgateway - (Computed) returns the gateway from the external network
- external_
network_ strnetmask - (Computed) returns the netmask from the external network
- href str
- Network Hypertext Reference
- id str
- The provider-assigned unique ID for this managed resource.
- external
Network StringDns1 - (Computed) returns the first DNS from the external network
- external
Network StringDns2 - (Computed) returns the second DNS from the external network
- external
Network StringDns Suffix - (Computed) returns the DNS suffix from the external network
- external
Network StringGateway - (Computed) returns the gateway from the external network
- external
Network StringNetmask - (Computed) returns the netmask from the external network
- href String
- Network Hypertext Reference
- id String
- The provider-assigned unique ID for this managed resource.
Look up Existing NetworkDirect Resource
Get an existing NetworkDirect resource’s state with the given name, ID, and optional extra properties used to qualify the lookup.
public static get(name: string, id: Input<ID>, state?: NetworkDirectState, opts?: CustomResourceOptions): NetworkDirect
@staticmethod
def get(resource_name: str,
id: str,
opts: Optional[ResourceOptions] = None,
description: Optional[str] = None,
external_network: Optional[str] = None,
external_network_dns1: Optional[str] = None,
external_network_dns2: Optional[str] = None,
external_network_dns_suffix: Optional[str] = None,
external_network_gateway: Optional[str] = None,
external_network_netmask: Optional[str] = None,
href: Optional[str] = None,
metadata: Optional[Mapping[str, str]] = None,
metadata_entries: Optional[Sequence[NetworkDirectMetadataEntryArgs]] = None,
name: Optional[str] = None,
network_direct_id: Optional[str] = None,
org: Optional[str] = None,
shared: Optional[bool] = None,
vdc: Optional[str] = None) -> NetworkDirect
func GetNetworkDirect(ctx *Context, name string, id IDInput, state *NetworkDirectState, opts ...ResourceOption) (*NetworkDirect, error)
public static NetworkDirect Get(string name, Input<string> id, NetworkDirectState? state, CustomResourceOptions? opts = null)
public static NetworkDirect get(String name, Output<String> id, NetworkDirectState state, CustomResourceOptions options)
resources: _: type: vcd:NetworkDirect get: id: ${id}
- name
- The unique name of the resulting resource.
- id
- The unique provider ID of the resource to lookup.
- state
- Any extra arguments used during the lookup.
- opts
- A bag of options that control this resource's behavior.
- resource_name
- The unique name of the resulting resource.
- id
- The unique provider ID of the resource to lookup.
- name
- The unique name of the resulting resource.
- id
- The unique provider ID of the resource to lookup.
- state
- Any extra arguments used during the lookup.
- opts
- A bag of options that control this resource's behavior.
- name
- The unique name of the resulting resource.
- id
- The unique provider ID of the resource to lookup.
- state
- Any extra arguments used during the lookup.
- opts
- A bag of options that control this resource's behavior.
- name
- The unique name of the resulting resource.
- id
- The unique provider ID of the resource to lookup.
- state
- Any extra arguments used during the lookup.
- opts
- A bag of options that control this resource's behavior.
- Description string
- An optional description of the network
- External
Network string - The name of the external network.
- External
Network stringDns1 - (Computed) returns the first DNS from the external network
- External
Network stringDns2 - (Computed) returns the second DNS from the external network
- External
Network stringDns Suffix - (Computed) returns the DNS suffix from the external network
- External
Network stringGateway - (Computed) returns the gateway from the external network
- External
Network stringNetmask - (Computed) returns the netmask from the external network
- Href string
- Network Hypertext Reference
- Metadata Dictionary<string, string>
- Use
metadata_entry
instead. Key value map of metadata to assign to this network. - Metadata
Entries List<NetworkDirect Metadata Entry> - A set of metadata entries to assign. See Metadata section for details.
- Name string
- A unique name for the network
- Network
Direct stringId - Org string
- The name of organization to use, optional if defined at provider level. Useful when connected as sysadmin working across different organisations
- bool
- Defines if this network is shared between multiple VDCs
in the Org. Defaults to
false
. - Vdc string
- The name of VDC to use, optional if defined at provider level
- Description string
- An optional description of the network
- External
Network string - The name of the external network.
- External
Network stringDns1 - (Computed) returns the first DNS from the external network
- External
Network stringDns2 - (Computed) returns the second DNS from the external network
- External
Network stringDns Suffix - (Computed) returns the DNS suffix from the external network
- External
Network stringGateway - (Computed) returns the gateway from the external network
- External
Network stringNetmask - (Computed) returns the netmask from the external network
- Href string
- Network Hypertext Reference
- Metadata map[string]string
- Use
metadata_entry
instead. Key value map of metadata to assign to this network. - Metadata
Entries []NetworkDirect Metadata Entry Args - A set of metadata entries to assign. See Metadata section for details.
- Name string
- A unique name for the network
- Network
Direct stringId - Org string
- The name of organization to use, optional if defined at provider level. Useful when connected as sysadmin working across different organisations
- bool
- Defines if this network is shared between multiple VDCs
in the Org. Defaults to
false
. - Vdc string
- The name of VDC to use, optional if defined at provider level
- description String
- An optional description of the network
- external
Network String - The name of the external network.
- external
Network StringDns1 - (Computed) returns the first DNS from the external network
- external
Network StringDns2 - (Computed) returns the second DNS from the external network
- external
Network StringDns Suffix - (Computed) returns the DNS suffix from the external network
- external
Network StringGateway - (Computed) returns the gateway from the external network
- external
Network StringNetmask - (Computed) returns the netmask from the external network
- href String
- Network Hypertext Reference
- metadata Map<String,String>
- Use
metadata_entry
instead. Key value map of metadata to assign to this network. - metadata
Entries List<NetworkDirect Metadata Entry> - A set of metadata entries to assign. See Metadata section for details.
- name String
- A unique name for the network
- network
Direct StringId - org String
- The name of organization to use, optional if defined at provider level. Useful when connected as sysadmin working across different organisations
- Boolean
- Defines if this network is shared between multiple VDCs
in the Org. Defaults to
false
. - vdc String
- The name of VDC to use, optional if defined at provider level
- description string
- An optional description of the network
- external
Network string - The name of the external network.
- external
Network stringDns1 - (Computed) returns the first DNS from the external network
- external
Network stringDns2 - (Computed) returns the second DNS from the external network
- external
Network stringDns Suffix - (Computed) returns the DNS suffix from the external network
- external
Network stringGateway - (Computed) returns the gateway from the external network
- external
Network stringNetmask - (Computed) returns the netmask from the external network
- href string
- Network Hypertext Reference
- metadata {[key: string]: string}
- Use
metadata_entry
instead. Key value map of metadata to assign to this network. - metadata
Entries NetworkDirect Metadata Entry[] - A set of metadata entries to assign. See Metadata section for details.
- name string
- A unique name for the network
- network
Direct stringId - org string
- The name of organization to use, optional if defined at provider level. Useful when connected as sysadmin working across different organisations
- boolean
- Defines if this network is shared between multiple VDCs
in the Org. Defaults to
false
. - vdc string
- The name of VDC to use, optional if defined at provider level
- description str
- An optional description of the network
- external_
network str - The name of the external network.
- external_
network_ strdns1 - (Computed) returns the first DNS from the external network
- external_
network_ strdns2 - (Computed) returns the second DNS from the external network
- external_
network_ strdns_ suffix - (Computed) returns the DNS suffix from the external network
- external_
network_ strgateway - (Computed) returns the gateway from the external network
- external_
network_ strnetmask - (Computed) returns the netmask from the external network
- href str
- Network Hypertext Reference
- metadata Mapping[str, str]
- Use
metadata_entry
instead. Key value map of metadata to assign to this network. - metadata_
entries Sequence[NetworkDirect Metadata Entry Args] - A set of metadata entries to assign. See Metadata section for details.
- name str
- A unique name for the network
- network_
direct_ strid - org str
- The name of organization to use, optional if defined at provider level. Useful when connected as sysadmin working across different organisations
- bool
- Defines if this network is shared between multiple VDCs
in the Org. Defaults to
false
. - vdc str
- The name of VDC to use, optional if defined at provider level
- description String
- An optional description of the network
- external
Network String - The name of the external network.
- external
Network StringDns1 - (Computed) returns the first DNS from the external network
- external
Network StringDns2 - (Computed) returns the second DNS from the external network
- external
Network StringDns Suffix - (Computed) returns the DNS suffix from the external network
- external
Network StringGateway - (Computed) returns the gateway from the external network
- external
Network StringNetmask - (Computed) returns the netmask from the external network
- href String
- Network Hypertext Reference
- metadata Map<String>
- Use
metadata_entry
instead. Key value map of metadata to assign to this network. - metadata
Entries List<Property Map> - A set of metadata entries to assign. See Metadata section for details.
- name String
- A unique name for the network
- network
Direct StringId - org String
- The name of organization to use, optional if defined at provider level. Useful when connected as sysadmin working across different organisations
- Boolean
- Defines if this network is shared between multiple VDCs
in the Org. Defaults to
false
. - vdc String
- The name of VDC to use, optional if defined at provider level
Supporting Types
NetworkDirectMetadataEntry, NetworkDirectMetadataEntryArgs
- Is
System bool - Domain for this metadata entry. true, if it belongs to SYSTEM. false, if it belongs to GENERAL
- Key string
- Key of this metadata entry. Required if the metadata entry is not empty
- Type string
- Type of this metadata entry. One of: 'MetadataStringValue', 'MetadataNumberValue', 'MetadataBooleanValue', 'MetadataDateTimeValue'
- User
Access string - User access level for this metadata entry. One of: 'READWRITE', 'READONLY', 'PRIVATE'
- Value string
- Value of this metadata entry. Required if the metadata entry is not empty
- Is
System bool - Domain for this metadata entry. true, if it belongs to SYSTEM. false, if it belongs to GENERAL
- Key string
- Key of this metadata entry. Required if the metadata entry is not empty
- Type string
- Type of this metadata entry. One of: 'MetadataStringValue', 'MetadataNumberValue', 'MetadataBooleanValue', 'MetadataDateTimeValue'
- User
Access string - User access level for this metadata entry. One of: 'READWRITE', 'READONLY', 'PRIVATE'
- Value string
- Value of this metadata entry. Required if the metadata entry is not empty
- is
System Boolean - Domain for this metadata entry. true, if it belongs to SYSTEM. false, if it belongs to GENERAL
- key String
- Key of this metadata entry. Required if the metadata entry is not empty
- type String
- Type of this metadata entry. One of: 'MetadataStringValue', 'MetadataNumberValue', 'MetadataBooleanValue', 'MetadataDateTimeValue'
- user
Access String - User access level for this metadata entry. One of: 'READWRITE', 'READONLY', 'PRIVATE'
- value String
- Value of this metadata entry. Required if the metadata entry is not empty
- is
System boolean - Domain for this metadata entry. true, if it belongs to SYSTEM. false, if it belongs to GENERAL
- key string
- Key of this metadata entry. Required if the metadata entry is not empty
- type string
- Type of this metadata entry. One of: 'MetadataStringValue', 'MetadataNumberValue', 'MetadataBooleanValue', 'MetadataDateTimeValue'
- user
Access string - User access level for this metadata entry. One of: 'READWRITE', 'READONLY', 'PRIVATE'
- value string
- Value of this metadata entry. Required if the metadata entry is not empty
- is_
system bool - Domain for this metadata entry. true, if it belongs to SYSTEM. false, if it belongs to GENERAL
- key str
- Key of this metadata entry. Required if the metadata entry is not empty
- type str
- Type of this metadata entry. One of: 'MetadataStringValue', 'MetadataNumberValue', 'MetadataBooleanValue', 'MetadataDateTimeValue'
- user_
access str - User access level for this metadata entry. One of: 'READWRITE', 'READONLY', 'PRIVATE'
- value str
- Value of this metadata entry. Required if the metadata entry is not empty
- is
System Boolean - Domain for this metadata entry. true, if it belongs to SYSTEM. false, if it belongs to GENERAL
- key String
- Key of this metadata entry. Required if the metadata entry is not empty
- type String
- Type of this metadata entry. One of: 'MetadataStringValue', 'MetadataNumberValue', 'MetadataBooleanValue', 'MetadataDateTimeValue'
- user
Access String - User access level for this metadata entry. One of: 'READWRITE', 'READONLY', 'PRIVATE'
- value String
- Value of this metadata entry. Required if the metadata entry is not empty
Package Details
- Repository
- vcd vmware/terraform-provider-vcd
- License
- Notes
- This Pulumi package is based on the
vcd
Terraform Provider.