VMware Cloud Director API - NatRuleType

VMware Cloud Director API - NatRuleType

NatRuleType

Type:
NatRuleType
Namespace:
http://www.vmware.com/vcloud/v1.5
Description:
Represents a NAT rule.
Since:
0.9
Schema:
network.xsd
Media type(s):
None
Extends:
VCloudExtensibleType
XML Representation:
<NatRuleType xmlns="http://www.vmware.com/vcloud/v1.5">
    <Description> xs:string </Description>
    <RuleType> xs:string </RuleType>
    <IsEnabled> xs:boolean </IsEnabled>
    <Id> xs:int </Id>
    <GatewayNatRule>
        <Interface href="xs:anyURI" id="xs:string" type="xs:string" name="xs:string"/>
        <OriginalIp> IpAddressType </OriginalIp>
        <OriginalPort> xs:string </OriginalPort>
        <TranslatedIp> IpAddressType </TranslatedIp>
        <TranslatedPort> xs:string </TranslatedPort>
        <Protocol> xs:string </Protocol>
        <IcmpSubType> xs:string </IcmpSubType>
    </GatewayNatRule>
    <OneToOneBasicRule>
        <MappingMode> xs:string </MappingMode>
        <ExternalIpAddress> IpAddressType </ExternalIpAddress>
        <InternalIpAddress> IpAddressType </InternalIpAddress>
    </OneToOneBasicRule>
    <OneToOneVmRule>
        <MappingMode> xs:string </MappingMode>
        <ExternalIpAddress> IpAddressType </ExternalIpAddress>
        <VAppScopedVmId> xs:string </VAppScopedVmId>
        <VmNicId> xs:int </VmNicId>
    </OneToOneVmRule>
    <PortForwardingRule>
        <ExternalIpAddress> IpAddressType </ExternalIpAddress>
        <ExternalPort> xs:int </ExternalPort>
        <InternalIpAddress> IpAddressType </InternalIpAddress>
        <InternalPort> xs:int </InternalPort>
        <Protocol> xs:string </Protocol>
    </PortForwardingRule>
    <VmRule>
        <ExternalIpAddress> IpAddressType </ExternalIpAddress>
        <ExternalPort> xs:int </ExternalPort>
        <VAppScopedVmId> xs:string </VAppScopedVmId>
        <VmNicId> xs:int </VmNicId>
        <InternalPort> xs:int </InternalPort>
        <Protocol> xs:string </Protocol>
    </VmRule>
</NatRuleType>

Elements

Element Type Required Modifiable Since Deprecated Description
Description string No always 1.0 Description of NAT rule.
GatewayNatRule GatewayNatRuleType No always 5.1 Defines SNAT and DNAT types.
Id int No always 5.1 Id of the rule. Can be used to track syslog messages.
IsEnabled boolean No always 5.1 Used to enabled or disable NAT rule.
OneToOneBasicRule NatOneToOneBasicRuleType No always 0.9 Maps one internal IP address to one external IP address.
OneToOneVmRule NatOneToOneVmRuleType No always 0.9 Maps one VM NIC to one external IP addresses.
PortForwardingRule NatPortForwardingRuleType No always 0.9 Port forwarding internal to external IP addresses.
RuleType string No always 5.1 Type of NAT rule. One of: SNAT (source NAT), DNAT (destination NAT)
VCloudExtension VCloudExtensionType No always 0.9 An optional extension element that can contain an arbitrary number of elements and attributes. Not related to extension services.
VmRule NatVmRuleType No always 0.9 Port forwarding VM NIC to external IP addresses.