Skip to content

Latest commit

 

History

History
55 lines (46 loc) · 5.39 KB

VirtualCircuit.md

File metadata and controls

55 lines (46 loc) · 5.39 KB
Raw

VirtualCircuit

Properties

Name Type Description Notes
bill bool True if the Virtual Circuit is being billed. Currently, only Virtual Circuits of Fabric VCs (Metal Billed) will be billed. Usage will start the first time the Virtual Circuit becomes active, and will not stop until it is deleted from Metal. [optional] [default to False]
bill_type str Fabric Billed if the Virtual Circuit is billed by Fabric. Metal Billed if the Virtual Circuit is billed by Metal. Legacy Virtual Circuits will have a value of nil. [optional]
created_at datetime [optional]
description str [optional]
href str [optional]
id str [optional]
name str [optional]
nni_vlan int [optional]
port InterconnectionPort [optional]
project Project [optional]
provider_connection_id str This field is relevant if using the `shared_port_vlan_to_csp` interconnection type. Once activated on the CSP, this field should contain the resource name that the virtual circuit is connected to on the provider's end. [optional]
speed int integer representing bps speed [optional]
status str The status changes of a VRF virtual circuit are generally the same as Virtual Circuits that aren't in a VRF. However, for VRF Virtual Circuits on Fabric VCs, the status will change to 'waiting_on_peering_details' once the Fabric service token associated with the virtual circuit has been redeemed on Fabric, and Metal has found the associated Fabric connection. At this point, users can update the subnet, MD5 password, customer IP and/or metal IP accordingly. For VRF Virtual Circuits on Dedicated Ports, we require all peering details to be set on creation of a VRF Virtual Circuit. The status will change to `changing_peering_details` whenever an active VRF Virtual Circuit has any of its peering details updated. [optional]
tags List[str] [optional]
type str [optional]
updated_at datetime [optional]
virtual_network Href [optional]
vnid int [optional]
customer_ip str An IPv4 address from the subnet that will be used on the Customer side. This parameter is optional, but if supplied, we will use the other usable IP address in the subnet as the Metal IP. By default, the last usable IP address in the subnet will be used. [optional]
customer_ipv6 str An IPv6 address from the subnet IPv6 that will be used on the Customer side. This parameter is optional, but if supplied, we will use the other usable IP address in the subnet IPv6 as the Metal IPv6. By default, the last usable IP address in the subnet IPv6 will be used. [optional]
md5 str The MD5 password for the BGP peering in plaintext (not a checksum). [optional]
metal_ip str An IPv4 address from the subnet that will be used on the Metal side. This parameter is optional, but if supplied, we will use the other usable IP address in the subnet as the Customer IP. By default, the first usable IP address in the subnet will be used. [optional]
metal_ipv6 str An IPv6 address from the subnet IPv6 that will be used on the Metal side. This parameter is optional, but if supplied, we will use the other usable IPv6 address in the subnet IPv6 as the Customer IP. By default, the first usable IPv6 address in the subnet IPv6 will be used. [optional]
peer_asn int The peer ASN that will be used with the VRF on the Virtual Circuit. [optional]
subnet str The /30 or /31 IPv4 subnet of one of the VRF IP Blocks that will be used with the VRF for the Virtual Circuit. This subnet does not have to be an existing VRF IP reservation, as we will create the VRF IP reservation on creation if it does not exist. The Metal IP and Customer IP must be IPs from this subnet. For /30 subnets, the network and broadcast IPs cannot be used as the Metal or Customer IP. [optional]
subnet_ipv6 str The /126 or /127 IPv6 subnet of one of the VRF IP Blocks that will be used with the VRF for the Virtual Circuit. This subnet does not have to be an existing VRF IP reservation, as we will create the VRF IP reservation on creation if it does not exist. The Metal IPv6 and Customer IPv6 must be IPs from this subnet. For /126 subnets, the network and broadcast IPs cannot be used as the Metal IPv6 or Customer IPv6. The subnet specified must be contained within an already-defined IP Range for the VRF. [optional]
vrf Vrf

Example

from equinix_metal.models.virtual_circuit import VirtualCircuit

# TODO update the JSON string below
json = "{}"
# create an instance of VirtualCircuit from a JSON string
virtual_circuit_instance = VirtualCircuit.from_json(json)
# print the JSON string representation of the object
print(VirtualCircuit.to_json())

# convert the object into a dict
virtual_circuit_dict = virtual_circuit_instance.to_dict()
# create an instance of VirtualCircuit from a dict
virtual_circuit_form_dict = virtual_circuit.from_dict(virtual_circuit_dict)

[Back to Model list] [Back to API list] [Back to README]