Docs Packages
  1. Packages
  2. Equinix
  3. API Docs
  4. fabric
  5. getRoutingProtocol
Equinix v0.8.0 published on Tuesday, Apr 2, 2024 by Equinix
equinix/pulumi-equinix

equinix.fabric.getRoutingProtocol

Explore with Pulumi AI

equinix logo
Equinix v0.8.0 published on Tuesday, Apr 2, 2024 by Equinix
equinix/pulumi-equinix

    Fabric V4 API compatible data resource that allow user to fetch routing protocol for a given UUID

    API documentation can be found here - https://developer.equinix.com/dev-docs/fabric/api-reference/fabric-v4-apis#routing-protocols

    Example Usage

    import * as pulumi from "@pulumi/pulumi";
import * as equinix from "@pulumi/equinix";

const routingProtocolDataName = equinix.fabric.getRoutingProtocol({
    connectionUuid: "<uuid_of_connection_routing_protocol_is_applied_to>",
    uuid: "<uuid_of_routing_protocol>",
});

    import pulumi
import pulumi_equinix as equinix

routing_protocol_data_name = equinix.fabric.get_routing_protocol(connection_uuid="<uuid_of_connection_routing_protocol_is_applied_to>",
    uuid="<uuid_of_routing_protocol>")

    package main

import (
	"github.com/equinix/pulumi-equinix/sdk/go/equinix/fabric"
	"github.com/pulumi/pulumi/sdk/v3/go/pulumi"
)

func main() {
	pulumi.Run(func(ctx *pulumi.Context) error {
		_, err := fabric.LookupRoutingProtocol(ctx, &fabric.LookupRoutingProtocolArgs{
			ConnectionUuid: "<uuid_of_connection_routing_protocol_is_applied_to>",
			Uuid:           "<uuid_of_routing_protocol>",
		}, nil)
		if err != nil {
			return err
		}
		return nil
	})
}

    using System.Collections.Generic;
using System.Linq;
using Pulumi;
using Equinix = Pulumi.Equinix;

return await Deployment.RunAsync(() => 
{
    var routingProtocolDataName = Equinix.Fabric.GetRoutingProtocol.Invoke(new()
    {
        ConnectionUuid = "<uuid_of_connection_routing_protocol_is_applied_to>",
        Uuid = "<uuid_of_routing_protocol>",
    });

});

    package generated_program;

import com.pulumi.Context;
import com.pulumi.Pulumi;
import com.pulumi.core.Output;
import com.pulumi.equinix.fabric.FabricFunctions;
import com.pulumi.equinix.fabric.inputs.GetRoutingProtocolArgs;
import java.util.List;
import java.util.ArrayList;
import java.util.Map;
import java.io.File;
import java.nio.file.Files;
import java.nio.file.Paths;

public class App {
    public static void main(String[] args) {
        Pulumi.run(App::stack);
    }

    public static void stack(Context ctx) {
        final var routingProtocolDataName = FabricFunctions.getRoutingProtocol(GetRoutingProtocolArgs.builder()
            .connectionUuid("<uuid_of_connection_routing_protocol_is_applied_to>")
            .uuid("<uuid_of_routing_protocol>")
            .build());

    }
}

    variables:
  routingProtocolDataName:
    fn::invoke:
      Function: equinix:fabric:getRoutingProtocol
      Arguments:
        connectionUuid: <uuid_of_connection_routing_protocol_is_applied_to>
        uuid: <uuid_of_routing_protocol>

    Using getRoutingProtocol

    Two invocation forms are available. The direct form accepts plain arguments and either blocks until the result value is available, or returns a Promise-wrapped result. The output form accepts Input-wrapped arguments and returns an Output-wrapped result.

    function getRoutingProtocol(args: GetRoutingProtocolArgs, opts?: InvokeOptions): Promise<GetRoutingProtocolResult>
function getRoutingProtocolOutput(args: GetRoutingProtocolOutputArgs, opts?: InvokeOptions): Output<GetRoutingProtocolResult>
    def get_routing_protocol(connection_uuid: Optional[str] = None,
                         uuid: Optional[str] = None,
                         opts: Optional[InvokeOptions] = None) -> GetRoutingProtocolResult
def get_routing_protocol_output(connection_uuid: Optional[pulumi.Input[str]] = None,
                         uuid: Optional[pulumi.Input[str]] = None,
                         opts: Optional[InvokeOptions] = None) -> Output[GetRoutingProtocolResult]
    func LookupRoutingProtocol(ctx *Context, args *LookupRoutingProtocolArgs, opts ...InvokeOption) (*LookupRoutingProtocolResult, error)
func LookupRoutingProtocolOutput(ctx *Context, args *LookupRoutingProtocolOutputArgs, opts ...InvokeOption) LookupRoutingProtocolResultOutput

    > Note: This function is named LookupRoutingProtocol in the Go SDK.

    public static class GetRoutingProtocol 
{
    public static Task<GetRoutingProtocolResult> InvokeAsync(GetRoutingProtocolArgs args, InvokeOptions? opts = null)
    public static Output<GetRoutingProtocolResult> Invoke(GetRoutingProtocolInvokeArgs args, InvokeOptions? opts = null)
}
    public static CompletableFuture<GetRoutingProtocolResult> getRoutingProtocol(GetRoutingProtocolArgs args, InvokeOptions options)
// Output-based functions aren't available in Java yet

    fn::invoke:
  function: equinix:fabric/getRoutingProtocol:getRoutingProtocol
  arguments:
    # arguments dictionary

    The following arguments are supported:

    ConnectionUuid string
    Connection URI associated with Routing Protocol
    Uuid string
    ConnectionUuid string
    Connection URI associated with Routing Protocol
    Uuid string
    connectionUuid String
    Connection URI associated with Routing Protocol
    uuid String
    connectionUuid string
    Connection URI associated with Routing Protocol
    uuid string
    connection_uuid str
    Connection URI associated with Routing Protocol
    uuid str
    connectionUuid String
    Connection URI associated with Routing Protocol
    uuid String

    getRoutingProtocol Result

    The following output properties are available:

    Bfd GetRoutingProtocolBfd
    Bidirectional Forwarding Detection
    BgpAuthKey string
    BGP authorization key
    BgpIpv4 GetRoutingProtocolBgpIpv4
    Routing Protocol BGP IPv4
    BgpIpv6 GetRoutingProtocolBgpIpv6
    Routing Protocol BGP IPv6
    ChangeLogs List<GetRoutingProtocolChangeLog>
    Captures Routing Protocol lifecycle change information
    Changes List<GetRoutingProtocolChange>
    Routing Protocol configuration Changes
    ConnectionUuid string
    Connection URI associated with Routing Protocol
    CustomerAsn int
    Customer-provided ASN
    Description string
    Customer-provided Fabric Routing Protocol description
    DirectIpv4 GetRoutingProtocolDirectIpv4
    Routing Protocol Direct IPv4
    DirectIpv6 GetRoutingProtocolDirectIpv6
    Routing Protocol Direct IPv6
    EquinixAsn int
    Equinix ASN
    Href string
    Routing Protocol URI information
    Id string
    The provider-assigned unique ID for this managed resource.
    Name string
    Routing Protocol name. An alpha-numeric 24 characters string which can include only hyphens and underscores
    Operations List<GetRoutingProtocolOperation>
    Routing Protocol type-specific operational data
    State string
    Routing Protocol overall state
    Type string
    Defines the routing protocol type like BGP or DIRECT
    Uuid string
    Equinix-assigned routing protocol identifier
    Bfd GetRoutingProtocolBfd
    Bidirectional Forwarding Detection
    BgpAuthKey string
    BGP authorization key
    BgpIpv4 GetRoutingProtocolBgpIpv4
    Routing Protocol BGP IPv4
    BgpIpv6 GetRoutingProtocolBgpIpv6
    Routing Protocol BGP IPv6
    ChangeLogs []GetRoutingProtocolChangeLog
    Captures Routing Protocol lifecycle change information
    Changes []GetRoutingProtocolChange
    Routing Protocol configuration Changes
    ConnectionUuid string
    Connection URI associated with Routing Protocol
    CustomerAsn int
    Customer-provided ASN
    Description string
    Customer-provided Fabric Routing Protocol description
    DirectIpv4 GetRoutingProtocolDirectIpv4
    Routing Protocol Direct IPv4
    DirectIpv6 GetRoutingProtocolDirectIpv6
    Routing Protocol Direct IPv6
    EquinixAsn int
    Equinix ASN
    Href string
    Routing Protocol URI information
    Id string
    The provider-assigned unique ID for this managed resource.
    Name string
    Routing Protocol name. An alpha-numeric 24 characters string which can include only hyphens and underscores
    Operations []GetRoutingProtocolOperation
    Routing Protocol type-specific operational data
    State string
    Routing Protocol overall state
    Type string
    Defines the routing protocol type like BGP or DIRECT
    Uuid string
    Equinix-assigned routing protocol identifier
    bfd GetRoutingProtocolBfd
    Bidirectional Forwarding Detection
    bgpAuthKey String
    BGP authorization key
    bgpIpv4 GetRoutingProtocolBgpIpv4
    Routing Protocol BGP IPv4
    bgpIpv6 GetRoutingProtocolBgpIpv6
    Routing Protocol BGP IPv6
    changeLogs List<GetRoutingProtocolChangeLog>
    Captures Routing Protocol lifecycle change information
    changes List<GetRoutingProtocolChange>
    Routing Protocol configuration Changes
    connectionUuid String
    Connection URI associated with Routing Protocol
    customerAsn Integer
    Customer-provided ASN
    description String
    Customer-provided Fabric Routing Protocol description
    directIpv4 GetRoutingProtocolDirectIpv4
    Routing Protocol Direct IPv4
    directIpv6 GetRoutingProtocolDirectIpv6
    Routing Protocol Direct IPv6
    equinixAsn Integer
    Equinix ASN
    href String
    Routing Protocol URI information
    id String
    The provider-assigned unique ID for this managed resource.
    name String
    Routing Protocol name. An alpha-numeric 24 characters string which can include only hyphens and underscores
    operations List<GetRoutingProtocolOperation>
    Routing Protocol type-specific operational data
    state String
    Routing Protocol overall state
    type String
    Defines the routing protocol type like BGP or DIRECT
    uuid String
    Equinix-assigned routing protocol identifier
    bfd GetRoutingProtocolBfd
    Bidirectional Forwarding Detection
    bgpAuthKey string
    BGP authorization key
    bgpIpv4 GetRoutingProtocolBgpIpv4
    Routing Protocol BGP IPv4
    bgpIpv6 GetRoutingProtocolBgpIpv6
    Routing Protocol BGP IPv6
    changeLogs GetRoutingProtocolChangeLog[]
    Captures Routing Protocol lifecycle change information
    changes GetRoutingProtocolChange[]
    Routing Protocol configuration Changes
    connectionUuid string
    Connection URI associated with Routing Protocol
    customerAsn number
    Customer-provided ASN
    description string
    Customer-provided Fabric Routing Protocol description
    directIpv4 GetRoutingProtocolDirectIpv4
    Routing Protocol Direct IPv4
    directIpv6 GetRoutingProtocolDirectIpv6
    Routing Protocol Direct IPv6
    equinixAsn number
    Equinix ASN
    href string
    Routing Protocol URI information
    id string
    The provider-assigned unique ID for this managed resource.
    name string
    Routing Protocol name. An alpha-numeric 24 characters string which can include only hyphens and underscores
    operations GetRoutingProtocolOperation[]
    Routing Protocol type-specific operational data
    state string
    Routing Protocol overall state
    type string
    Defines the routing protocol type like BGP or DIRECT
    uuid string
    Equinix-assigned routing protocol identifier
    bfd GetRoutingProtocolBfd
    Bidirectional Forwarding Detection
    bgp_auth_key str
    BGP authorization key
    bgp_ipv4 GetRoutingProtocolBgpIpv4
    Routing Protocol BGP IPv4
    bgp_ipv6 GetRoutingProtocolBgpIpv6
    Routing Protocol BGP IPv6
    change_logs Sequence[GetRoutingProtocolChangeLog]
    Captures Routing Protocol lifecycle change information
    changes Sequence[GetRoutingProtocolChange]
    Routing Protocol configuration Changes
    connection_uuid str
    Connection URI associated with Routing Protocol
    customer_asn int
    Customer-provided ASN
    description str
    Customer-provided Fabric Routing Protocol description
    direct_ipv4 GetRoutingProtocolDirectIpv4
    Routing Protocol Direct IPv4
    direct_ipv6 GetRoutingProtocolDirectIpv6
    Routing Protocol Direct IPv6
    equinix_asn int
    Equinix ASN
    href str
    Routing Protocol URI information
    id str
    The provider-assigned unique ID for this managed resource.
    name str
    Routing Protocol name. An alpha-numeric 24 characters string which can include only hyphens and underscores
    operations Sequence[GetRoutingProtocolOperation]
    Routing Protocol type-specific operational data
    state str
    Routing Protocol overall state
    type str
    Defines the routing protocol type like BGP or DIRECT
    uuid str
    Equinix-assigned routing protocol identifier
    bfd Property Map
    Bidirectional Forwarding Detection
    bgpAuthKey String
    BGP authorization key
    bgpIpv4 Property Map
    Routing Protocol BGP IPv4
    bgpIpv6 Property Map
    Routing Protocol BGP IPv6
    changeLogs List<Property Map>
    Captures Routing Protocol lifecycle change information
    changes List<Property Map>
    Routing Protocol configuration Changes
    connectionUuid String
    Connection URI associated with Routing Protocol
    customerAsn Number
    Customer-provided ASN
    description String
    Customer-provided Fabric Routing Protocol description
    directIpv4 Property Map
    Routing Protocol Direct IPv4
    directIpv6 Property Map
    Routing Protocol Direct IPv6
    equinixAsn Number
    Equinix ASN
    href String
    Routing Protocol URI information
    id String
    The provider-assigned unique ID for this managed resource.
    name String
    Routing Protocol name. An alpha-numeric 24 characters string which can include only hyphens and underscores
    operations List<Property Map>
    Routing Protocol type-specific operational data
    state String
    Routing Protocol overall state
    type String
    Defines the routing protocol type like BGP or DIRECT
    uuid String
    Equinix-assigned routing protocol identifier

    Supporting Types

    GetRoutingProtocolBfd

    Enabled bool
    Bidirectional Forwarding Detection enablement
    Interval string
    Interval range between the received BFD control packets
    Enabled bool
    Bidirectional Forwarding Detection enablement
    Interval string
    Interval range between the received BFD control packets
    enabled Boolean
    Bidirectional Forwarding Detection enablement
    interval String
    Interval range between the received BFD control packets
    enabled boolean
    Bidirectional Forwarding Detection enablement
    interval string
    Interval range between the received BFD control packets
    enabled bool
    Bidirectional Forwarding Detection enablement
    interval str
    Interval range between the received BFD control packets
    enabled Boolean
    Bidirectional Forwarding Detection enablement
    interval String
    Interval range between the received BFD control packets

    GetRoutingProtocolBgpIpv4

    CustomerPeerIp string
    Customer side peering ip
    EquinixPeerIp string
    Equinix side peering ip
    Enabled bool
    Admin status for the BGP session
    CustomerPeerIp string
    Customer side peering ip
    EquinixPeerIp string
    Equinix side peering ip
    Enabled bool
    Admin status for the BGP session
    customerPeerIp String
    Customer side peering ip
    equinixPeerIp String
    Equinix side peering ip
    enabled Boolean
    Admin status for the BGP session
    customerPeerIp string
    Customer side peering ip
    equinixPeerIp string
    Equinix side peering ip
    enabled boolean
    Admin status for the BGP session
    customer_peer_ip str
    Customer side peering ip
    equinix_peer_ip str
    Equinix side peering ip
    enabled bool
    Admin status for the BGP session
    customerPeerIp String
    Customer side peering ip
    equinixPeerIp String
    Equinix side peering ip
    enabled Boolean
    Admin status for the BGP session

    GetRoutingProtocolBgpIpv6

    CustomerPeerIp string
    Customer side peering ip
    EquinixPeerIp string
    Equinix side peering ip
    Enabled bool
    Admin status for the BGP session
    CustomerPeerIp string
    Customer side peering ip
    EquinixPeerIp string
    Equinix side peering ip
    Enabled bool
    Admin status for the BGP session
    customerPeerIp String
    Customer side peering ip
    equinixPeerIp String
    Equinix side peering ip
    enabled Boolean
    Admin status for the BGP session
    customerPeerIp string
    Customer side peering ip
    equinixPeerIp string
    Equinix side peering ip
    enabled boolean
    Admin status for the BGP session
    customer_peer_ip str
    Customer side peering ip
    equinix_peer_ip str
    Equinix side peering ip
    enabled bool
    Admin status for the BGP session
    customerPeerIp String
    Customer side peering ip
    equinixPeerIp String
    Equinix side peering ip
    enabled Boolean
    Admin status for the BGP session

    GetRoutingProtocolChange

    Href string
    Routing Protocol Change URI
    Type string
    Type of change
    Uuid string
    Uniquely identifies a change
    Href string
    Routing Protocol Change URI
    Type string
    Type of change
    Uuid string
    Uniquely identifies a change
    href String
    Routing Protocol Change URI
    type String
    Type of change
    uuid String
    Uniquely identifies a change
    href string
    Routing Protocol Change URI
    type string
    Type of change
    uuid string
    Uniquely identifies a change
    href str
    Routing Protocol Change URI
    type str
    Type of change
    uuid str
    Uniquely identifies a change
    href String
    Routing Protocol Change URI
    type String
    Type of change
    uuid String
    Uniquely identifies a change

    GetRoutingProtocolChangeLog

    CreatedBy string
    Created by User Key
    CreatedByEmail string
    Created by User Email Address
    CreatedByFullName string
    Created by User Full Name
    CreatedDateTime string
    Created by Date and Time
    DeletedBy string
    Deleted by User Key
    DeletedByEmail string
    Deleted by User Email Address
    DeletedByFullName string
    Deleted by User Full Name
    DeletedDateTime string
    Deleted by Date and Time
    UpdatedBy string
    Updated by User Key
    UpdatedByEmail string
    Updated by User Email Address
    UpdatedByFullName string
    Updated by User Full Name
    UpdatedDateTime string
    Updated by Date and Time
    CreatedBy string
    Created by User Key
    CreatedByEmail string
    Created by User Email Address
    CreatedByFullName string
    Created by User Full Name
    CreatedDateTime string
    Created by Date and Time
    DeletedBy string
    Deleted by User Key
    DeletedByEmail string
    Deleted by User Email Address
    DeletedByFullName string
    Deleted by User Full Name
    DeletedDateTime string
    Deleted by Date and Time
    UpdatedBy string
    Updated by User Key
    UpdatedByEmail string
    Updated by User Email Address
    UpdatedByFullName string
    Updated by User Full Name
    UpdatedDateTime string
    Updated by Date and Time
    createdBy String
    Created by User Key
    createdByEmail String
    Created by User Email Address
    createdByFullName String
    Created by User Full Name
    createdDateTime String
    Created by Date and Time
    deletedBy String
    Deleted by User Key
    deletedByEmail String
    Deleted by User Email Address
    deletedByFullName String
    Deleted by User Full Name
    deletedDateTime String
    Deleted by Date and Time
    updatedBy String
    Updated by User Key
    updatedByEmail String
    Updated by User Email Address
    updatedByFullName String
    Updated by User Full Name
    updatedDateTime String
    Updated by Date and Time
    createdBy string
    Created by User Key
    createdByEmail string
    Created by User Email Address
    createdByFullName string
    Created by User Full Name
    createdDateTime string
    Created by Date and Time
    deletedBy string
    Deleted by User Key
    deletedByEmail string
    Deleted by User Email Address
    deletedByFullName string
    Deleted by User Full Name
    deletedDateTime string
    Deleted by Date and Time
    updatedBy string
    Updated by User Key
    updatedByEmail string
    Updated by User Email Address
    updatedByFullName string
    Updated by User Full Name
    updatedDateTime string
    Updated by Date and Time
    created_by str
    Created by User Key
    created_by_email str
    Created by User Email Address
    created_by_full_name str
    Created by User Full Name
    created_date_time str
    Created by Date and Time
    deleted_by str
    Deleted by User Key
    deleted_by_email str
    Deleted by User Email Address
    deleted_by_full_name str
    Deleted by User Full Name
    deleted_date_time str
    Deleted by Date and Time
    updated_by str
    Updated by User Key
    updated_by_email str
    Updated by User Email Address
    updated_by_full_name str
    Updated by User Full Name
    updated_date_time str
    Updated by Date and Time
    createdBy String
    Created by User Key
    createdByEmail String
    Created by User Email Address
    createdByFullName String
    Created by User Full Name
    createdDateTime String
    Created by Date and Time
    deletedBy String
    Deleted by User Key
    deletedByEmail String
    Deleted by User Email Address
    deletedByFullName String
    Deleted by User Full Name
    deletedDateTime String
    Deleted by Date and Time
    updatedBy String
    Updated by User Key
    updatedByEmail String
    Updated by User Email Address
    updatedByFullName String
    Updated by User Full Name
    updatedDateTime String
    Updated by Date and Time

    GetRoutingProtocolDirectIpv4

    EquinixIfaceIp string
    Equinix side Interface IP address
    EquinixIfaceIp string
    Equinix side Interface IP address
    equinixIfaceIp String
    Equinix side Interface IP address
    equinixIfaceIp string
    Equinix side Interface IP address
    equinix_iface_ip str
    Equinix side Interface IP address
    equinixIfaceIp String
    Equinix side Interface IP address

    GetRoutingProtocolDirectIpv6

    EquinixIfaceIp string
    Equinix side Interface IP address
    EquinixIfaceIp string
    Equinix side Interface IP address
    equinixIfaceIp String
    Equinix side Interface IP address
    equinixIfaceIp string
    Equinix side Interface IP address
    equinix_iface_ip str
    Equinix side Interface IP address
    equinixIfaceIp String
    Equinix side Interface IP address

    GetRoutingProtocolOperation

    errors List<Property Map>
    Errors occurred

    GetRoutingProtocolOperationError

    AdditionalInfos List<GetRoutingProtocolOperationErrorAdditionalInfo>
    Pricing error additional Info
    CorrelationId string
    CorrelationId
    Details string
    Details
    ErrorCode string
    Error code
    ErrorMessage string
    Error Message
    Help string
    Help
    AdditionalInfos []GetRoutingProtocolOperationErrorAdditionalInfo
    Pricing error additional Info
    CorrelationId string
    CorrelationId
    Details string
    Details
    ErrorCode string
    Error code
    ErrorMessage string
    Error Message
    Help string
    Help
    additionalInfos List<GetRoutingProtocolOperationErrorAdditionalInfo>
    Pricing error additional Info
    correlationId String
    CorrelationId
    details String
    Details
    errorCode String
    Error code
    errorMessage String
    Error Message
    help String
    Help
    additionalInfos GetRoutingProtocolOperationErrorAdditionalInfo[]
    Pricing error additional Info
    correlationId string
    CorrelationId
    details string
    Details
    errorCode string
    Error code
    errorMessage string
    Error Message
    help string
    Help
    additional_infos Sequence[GetRoutingProtocolOperationErrorAdditionalInfo]
    Pricing error additional Info
    correlation_id str
    CorrelationId
    details str
    Details
    error_code str
    Error code
    error_message str
    Error Message
    help str
    Help
    additionalInfos List<Property Map>
    Pricing error additional Info
    correlationId String
    CorrelationId
    details String
    Details
    errorCode String
    Error code
    errorMessage String
    Error Message
    help String
    Help

    GetRoutingProtocolOperationErrorAdditionalInfo

    Property string
    Property at which the error potentially occurred
    Reason string
    Reason for the error
    Property string
    Property at which the error potentially occurred
    Reason string
    Reason for the error
    property String
    Property at which the error potentially occurred
    reason String
    Reason for the error
    property string
    Property at which the error potentially occurred
    reason string
    Reason for the error
    property str
    Property at which the error potentially occurred
    reason str
    Reason for the error
    property String
    Property at which the error potentially occurred
    reason String
    Reason for the error

    Package Details

    Repository
    equinix equinix/pulumi-equinix
    License
    Apache-2.0
    Notes
    This Pulumi package is based on the equinix Terraform Provider.
    equinix logo
    Equinix v0.8.0 published on Tuesday, Apr 2, 2024 by Equinix
    equinix/pulumi-equinix