Skip to content

/AWS1/CL_DCONEWPVTVIRTUALINT00

Information about a private virtual interface to be provisioned on a connection.

CONSTRUCTOR

IMPORTING

Required arguments:

iv_virtualinterfacename TYPE /AWS1/DCOVIRTUALINTERFACENAME /AWS1/DCOVIRTUALINTERFACENAME

The name of the virtual interface assigned by the customer network. The name has a maximum of 100 characters. The following are valid characters: a-z, 0-9 and a hyphen (-).

iv_vlan TYPE /AWS1/DCOVLAN /AWS1/DCOVLAN

The ID of the VLAN.

Optional arguments:

iv_asn TYPE /AWS1/DCOASN /AWS1/DCOASN

The autonomous system number (ASN). The valid range is from 1 to 2147483646 for Border Gateway Protocol (BGP) configuration. If you provide a number greater than the maximum, an error is returned. Use asnLong instead.

  • You can use asnLong or asn, but not both. We recommend using asnLong as it supports a greater pool of numbers.

  • If you provide a value in the same API call for both asn and asnLong, the API will only accept the value for asnLong.

  • If you enter a 4-byte ASN for the asn parameter, the API returns an error.

  • If you are using a 2-byte ASN, the API response will include the 2-byte value for both the asn and asnLong fields.

The valid values are 1-2147483646.

iv_asnlong TYPE /AWS1/DCOLONGASN /AWS1/DCOLONGASN

The ASN when allocating a new private virtual interface. The valid range is from 1 to 4294967294 for BGP configuration.

Note the following limitations when using asnLong:

  • You can use asnLong or asn, but not both. We recommend using asnLong as it supports a greater pool of numbers.

  • asnLong accepts any valid ASN value, regardless if it's 2-byte or 4-byte.

  • When using a 4-byte asnLong, the API response returns 0 for the legacy asn attribute since 4-byte ASN values exceed the maximum supported value of 2,147,483,647.

  • If you are using a 2-byte ASN, the API response will include the 2-byte value for both the asn and asnLong fields.

  • If you provide a value in the same API call for both asn and asnLong, the API will only accept the value for asnLong.

iv_mtu TYPE /AWS1/DCOMTU /AWS1/DCOMTU

The maximum transmission unit (MTU), in bytes. The supported values are 1500 and 8500. The default value is 1500.

iv_authkey TYPE /AWS1/DCOBGPAUTHKEY /AWS1/DCOBGPAUTHKEY

The authentication key for BGP configuration. This string has a minimum length of 6 characters and and a maximun lenth of 80 characters.

iv_amazonaddress TYPE /AWS1/DCOAMAZONADDRESS /AWS1/DCOAMAZONADDRESS

The IP address assigned to the Amazon interface.

iv_addressfamily TYPE /AWS1/DCOADDRESSFAMILY /AWS1/DCOADDRESSFAMILY

The address family for the BGP peer.

iv_customeraddress TYPE /AWS1/DCOCUSTOMERADDRESS /AWS1/DCOCUSTOMERADDRESS

The IP address assigned to the customer interface.

it_tags TYPE /AWS1/CL_DCOTAG=>TT_TAGLIST TT_TAGLIST

The tags associated with the private virtual interface.

iv_ratelimit TYPE /AWS1/DCORATELIMIT /AWS1/DCORATELIMIT

The rate limit (bandwidth allocation) to apply to the virtual interface. The rate limit restricts the maximum bandwidth that the virtual interface can use on the parent connection.

Queryable Attributes

virtualInterfaceName

The name of the virtual interface assigned by the customer network. The name has a maximum of 100 characters. The following are valid characters: a-z, 0-9 and a hyphen (-).

Accessible with the following methods

Method Description
GET_VIRTUALINTERFACENAME() Getter for VIRTUALINTERFACENAME, with configurable default
ASK_VIRTUALINTERFACENAME() Getter for VIRTUALINTERFACENAME w/ exceptions if field has n
HAS_VIRTUALINTERFACENAME() Determine if VIRTUALINTERFACENAME has a value

vlan

The ID of the VLAN.

Accessible with the following methods

Method Description
GET_VLAN() Getter for VLAN

asn

The autonomous system number (ASN). The valid range is from 1 to 2147483646 for Border Gateway Protocol (BGP) configuration. If you provide a number greater than the maximum, an error is returned. Use asnLong instead.

  • You can use asnLong or asn, but not both. We recommend using asnLong as it supports a greater pool of numbers.

  • If you provide a value in the same API call for both asn and asnLong, the API will only accept the value for asnLong.

  • If you enter a 4-byte ASN for the asn parameter, the API returns an error.

  • If you are using a 2-byte ASN, the API response will include the 2-byte value for both the asn and asnLong fields.

The valid values are 1-2147483646.

Accessible with the following methods

Method Description
GET_ASN() Getter for ASN

asnLong

The ASN when allocating a new private virtual interface. The valid range is from 1 to 4294967294 for BGP configuration.

Note the following limitations when using asnLong:

  • You can use asnLong or asn, but not both. We recommend using asnLong as it supports a greater pool of numbers.

  • asnLong accepts any valid ASN value, regardless if it's 2-byte or 4-byte.

  • When using a 4-byte asnLong, the API response returns 0 for the legacy asn attribute since 4-byte ASN values exceed the maximum supported value of 2,147,483,647.

  • If you are using a 2-byte ASN, the API response will include the 2-byte value for both the asn and asnLong fields.

  • If you provide a value in the same API call for both asn and asnLong, the API will only accept the value for asnLong.

Accessible with the following methods

Method Description
GET_ASNLONG() Getter for ASNLONG, with configurable default
ASK_ASNLONG() Getter for ASNLONG w/ exceptions if field has no value
HAS_ASNLONG() Determine if ASNLONG has a value

mtu

The maximum transmission unit (MTU), in bytes. The supported values are 1500 and 8500. The default value is 1500.

Accessible with the following methods

Method Description
GET_MTU() Getter for MTU, with configurable default
ASK_MTU() Getter for MTU w/ exceptions if field has no value
HAS_MTU() Determine if MTU has a value

authKey

The authentication key for BGP configuration. This string has a minimum length of 6 characters and and a maximun lenth of 80 characters.

Accessible with the following methods

Method Description
GET_AUTHKEY() Getter for AUTHKEY, with configurable default
ASK_AUTHKEY() Getter for AUTHKEY w/ exceptions if field has no value
HAS_AUTHKEY() Determine if AUTHKEY has a value

amazonAddress

The IP address assigned to the Amazon interface.

Accessible with the following methods

Method Description
GET_AMAZONADDRESS() Getter for AMAZONADDRESS, with configurable default
ASK_AMAZONADDRESS() Getter for AMAZONADDRESS w/ exceptions if field has no value
HAS_AMAZONADDRESS() Determine if AMAZONADDRESS has a value

addressFamily

The address family for the BGP peer.

Accessible with the following methods

Method Description
GET_ADDRESSFAMILY() Getter for ADDRESSFAMILY, with configurable default
ASK_ADDRESSFAMILY() Getter for ADDRESSFAMILY w/ exceptions if field has no value
HAS_ADDRESSFAMILY() Determine if ADDRESSFAMILY has a value

customerAddress

The IP address assigned to the customer interface.

Accessible with the following methods

Method Description
GET_CUSTOMERADDRESS() Getter for CUSTOMERADDRESS, with configurable default
ASK_CUSTOMERADDRESS() Getter for CUSTOMERADDRESS w/ exceptions if field has no val
HAS_CUSTOMERADDRESS() Determine if CUSTOMERADDRESS has a value

tags

The tags associated with the private virtual interface.

Accessible with the following methods

Method Description
GET_TAGS() Getter for TAGS, with configurable default
ASK_TAGS() Getter for TAGS w/ exceptions if field has no value
HAS_TAGS() Determine if TAGS has a value

rateLimit

The rate limit (bandwidth allocation) to apply to the virtual interface. The rate limit restricts the maximum bandwidth that the virtual interface can use on the parent connection.

Accessible with the following methods

Method Description
GET_RATELIMIT() Getter for RATELIMIT, with configurable default
ASK_RATELIMIT() Getter for RATELIMIT w/ exceptions if field has no value
HAS_RATELIMIT() Determine if RATELIMIT has a value