Docs Home Pulumi IaC Pulumi ESC Pulumi Insights Pulumi IDP Pulumi Cloud Packages Tutorials
  1. Packages
  2. Ibm Provider
  3. API Docs
  4. getDlGatewayMacsecConfig
ibm 1.80.0-beta0 published on Tuesday, Jun 24, 2025 by ibm-cloud
ibm-cloud/terraform-provider-ibm

ibm.getDlGatewayMacsecConfig

Explore with Pulumi AI

ibm logo
ibm 1.80.0-beta0 published on Tuesday, Jun 24, 2025 by ibm-cloud
ibm-cloud/terraform-provider-ibm

    Retrieve the MACsec configuration of a IBM Cloud Infrastructure Direct Link Gateway. For more information, about IBM Cloud Direct Link, see getting started with IBM Cloud Direct Link.

    Example Usage

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

const test = ibm.getDlGatewayMacsecConfig({
    gateway: "0a06fb9b-820f-4c44-8a31-77f1f0806d28",
});

    import pulumi
import pulumi_ibm as ibm

test = ibm.get_dl_gateway_macsec_config(gateway="0a06fb9b-820f-4c44-8a31-77f1f0806d28")

    package main

import (
	"github.com/pulumi/pulumi-terraform-provider/sdks/go/ibm/ibm"
	"github.com/pulumi/pulumi/sdk/v3/go/pulumi"
)

func main() {
	pulumi.Run(func(ctx *pulumi.Context) error {
		_, err := ibm.LookupDlGatewayMacsecConfig(ctx, &ibm.LookupDlGatewayMacsecConfigArgs{
			Gateway: "0a06fb9b-820f-4c44-8a31-77f1f0806d28",
		}, nil)
		if err != nil {
			return err
		}
		return nil
	})
}

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

return await Deployment.RunAsync(() => 
{
    var test = Ibm.GetDlGatewayMacsecConfig.Invoke(new()
    {
        Gateway = "0a06fb9b-820f-4c44-8a31-77f1f0806d28",
    });

});

    package generated_program;

import com.pulumi.Context;
import com.pulumi.Pulumi;
import com.pulumi.core.Output;
import com.pulumi.ibm.IbmFunctions;
import com.pulumi.ibm.inputs.GetDlGatewayMacsecConfigArgs;
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 test = IbmFunctions.getDlGatewayMacsecConfig(GetDlGatewayMacsecConfigArgs.builder()
            .gateway("0a06fb9b-820f-4c44-8a31-77f1f0806d28")
            .build());

    }
}

    variables:
  test:
    fn::invoke:
      function: ibm:getDlGatewayMacsecConfig
      arguments:
        gateway: 0a06fb9b-820f-4c44-8a31-77f1f0806d28

    Using getDlGatewayMacsecConfig

    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 getDlGatewayMacsecConfig(args: GetDlGatewayMacsecConfigArgs, opts?: InvokeOptions): Promise<GetDlGatewayMacsecConfigResult>
function getDlGatewayMacsecConfigOutput(args: GetDlGatewayMacsecConfigOutputArgs, opts?: InvokeOptions): Output<GetDlGatewayMacsecConfigResult>
    def get_dl_gateway_macsec_config(gateway: Optional[str] = None,
                                 id: Optional[str] = None,
                                 opts: Optional[InvokeOptions] = None) -> GetDlGatewayMacsecConfigResult
def get_dl_gateway_macsec_config_output(gateway: Optional[pulumi.Input[str]] = None,
                                 id: Optional[pulumi.Input[str]] = None,
                                 opts: Optional[InvokeOptions] = None) -> Output[GetDlGatewayMacsecConfigResult]
    func LookupDlGatewayMacsecConfig(ctx *Context, args *LookupDlGatewayMacsecConfigArgs, opts ...InvokeOption) (*LookupDlGatewayMacsecConfigResult, error)
func LookupDlGatewayMacsecConfigOutput(ctx *Context, args *LookupDlGatewayMacsecConfigOutputArgs, opts ...InvokeOption) LookupDlGatewayMacsecConfigResultOutput

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

    public static class GetDlGatewayMacsecConfig 
{
    public static Task<GetDlGatewayMacsecConfigResult> InvokeAsync(GetDlGatewayMacsecConfigArgs args, InvokeOptions? opts = null)
    public static Output<GetDlGatewayMacsecConfigResult> Invoke(GetDlGatewayMacsecConfigInvokeArgs args, InvokeOptions? opts = null)
}
    public static CompletableFuture<GetDlGatewayMacsecConfigResult> getDlGatewayMacsecConfig(GetDlGatewayMacsecConfigArgs args, InvokeOptions options)
public static Output<GetDlGatewayMacsecConfigResult> getDlGatewayMacsecConfig(GetDlGatewayMacsecConfigArgs args, InvokeOptions options)

    fn::invoke:
  function: ibm:index/getDlGatewayMacsecConfig:getDlGatewayMacsecConfig
  arguments:
    # arguments dictionary

    The following arguments are supported:

    Gateway string
    Direct Link gateway identifier.
    Id string
    Gateway string
    Direct Link gateway identifier.
    Id string
    gateway String
    Direct Link gateway identifier.
    id String
    gateway string
    Direct Link gateway identifier.
    id string
    gateway str
    Direct Link gateway identifier.
    id str
    gateway String
    Direct Link gateway identifier.
    id String

    getDlGatewayMacsecConfig Result

    The following output properties are available:

    Active bool
    (Bool) Indicates if the MACsec feature is currently active (true) or inactive (false) for a gateway.
    CipherSuite string
    (String) The cipher suite used in generating the security association key (SAK).
    ConfidentialityOffset double
    (Integer) The confidentiality offset determines the number of octets in an Ethernet frame that are not encrypted.
    CreatedAt string
    (String) The date and time the resource was created.
    Gateway string
    Id string
    KeyServerPriority double
    (Integer) Used in the MACsec Key Agreement (MKA) protocol to determine which peer acts as the key server. Lower values indicate a higher preference to be the key server. The MACsec configuration on the direct link will always set this value to 255.
    SakRekeys List<GetDlGatewayMacsecConfigSakRekey>
    (List) Determines how SAK rekeying occurs. It is either timer based or based on the amount of used packet numbers. Nested scheme for sak_rekey:
    SecurityPolicy string
    (String) Determines how packets without MACsec headers are handled. must_secure - Packets without MACsec headers are dropped. This policy should be used to prefer security over network availability. should_secure - Packets without MACsec headers are allowed. This policy should be used to prefer network availability over security.
    Status string
    (String) Current status of MACsec on this direct link. Status offline is returned when MACsec is inactive and during direct link creation. Status deleting is returned when MACsec during removal of MACsec from the direct link and during direct link deletion. See status_reasons[] for possible remediation of the failed status.
    StatusReasons List<GetDlGatewayMacsecConfigStatusReason>
    (List) Context for certain values of status. Nested Schema for status_reasons:
    UpdatedAt string
    (String) The date and time the resource was last updated.
    WindowSize double
    (Integer) The window size determines the number of frames in a window for replay protection. Replay protection is used to counter replay attacks. Frames within a window size can be out of order and are not replay protected.
    Active bool
    (Bool) Indicates if the MACsec feature is currently active (true) or inactive (false) for a gateway.
    CipherSuite string
    (String) The cipher suite used in generating the security association key (SAK).
    ConfidentialityOffset float64
    (Integer) The confidentiality offset determines the number of octets in an Ethernet frame that are not encrypted.
    CreatedAt string
    (String) The date and time the resource was created.
    Gateway string
    Id string
    KeyServerPriority float64
    (Integer) Used in the MACsec Key Agreement (MKA) protocol to determine which peer acts as the key server. Lower values indicate a higher preference to be the key server. The MACsec configuration on the direct link will always set this value to 255.
    SakRekeys []GetDlGatewayMacsecConfigSakRekey
    (List) Determines how SAK rekeying occurs. It is either timer based or based on the amount of used packet numbers. Nested scheme for sak_rekey:
    SecurityPolicy string
    (String) Determines how packets without MACsec headers are handled. must_secure - Packets without MACsec headers are dropped. This policy should be used to prefer security over network availability. should_secure - Packets without MACsec headers are allowed. This policy should be used to prefer network availability over security.
    Status string
    (String) Current status of MACsec on this direct link. Status offline is returned when MACsec is inactive and during direct link creation. Status deleting is returned when MACsec during removal of MACsec from the direct link and during direct link deletion. See status_reasons[] for possible remediation of the failed status.
    StatusReasons []GetDlGatewayMacsecConfigStatusReason
    (List) Context for certain values of status. Nested Schema for status_reasons:
    UpdatedAt string
    (String) The date and time the resource was last updated.
    WindowSize float64
    (Integer) The window size determines the number of frames in a window for replay protection. Replay protection is used to counter replay attacks. Frames within a window size can be out of order and are not replay protected.
    active Boolean
    (Bool) Indicates if the MACsec feature is currently active (true) or inactive (false) for a gateway.
    cipherSuite String
    (String) The cipher suite used in generating the security association key (SAK).
    confidentialityOffset Double
    (Integer) The confidentiality offset determines the number of octets in an Ethernet frame that are not encrypted.
    createdAt String
    (String) The date and time the resource was created.
    gateway String
    id String
    keyServerPriority Double
    (Integer) Used in the MACsec Key Agreement (MKA) protocol to determine which peer acts as the key server. Lower values indicate a higher preference to be the key server. The MACsec configuration on the direct link will always set this value to 255.
    sakRekeys List<GetDlGatewayMacsecConfigSakRekey>
    (List) Determines how SAK rekeying occurs. It is either timer based or based on the amount of used packet numbers. Nested scheme for sak_rekey:
    securityPolicy String
    (String) Determines how packets without MACsec headers are handled. must_secure - Packets without MACsec headers are dropped. This policy should be used to prefer security over network availability. should_secure - Packets without MACsec headers are allowed. This policy should be used to prefer network availability over security.
    status String
    (String) Current status of MACsec on this direct link. Status offline is returned when MACsec is inactive and during direct link creation. Status deleting is returned when MACsec during removal of MACsec from the direct link and during direct link deletion. See status_reasons[] for possible remediation of the failed status.
    statusReasons List<GetDlGatewayMacsecConfigStatusReason>
    (List) Context for certain values of status. Nested Schema for status_reasons:
    updatedAt String
    (String) The date and time the resource was last updated.
    windowSize Double
    (Integer) The window size determines the number of frames in a window for replay protection. Replay protection is used to counter replay attacks. Frames within a window size can be out of order and are not replay protected.
    active boolean
    (Bool) Indicates if the MACsec feature is currently active (true) or inactive (false) for a gateway.
    cipherSuite string
    (String) The cipher suite used in generating the security association key (SAK).
    confidentialityOffset number
    (Integer) The confidentiality offset determines the number of octets in an Ethernet frame that are not encrypted.
    createdAt string
    (String) The date and time the resource was created.
    gateway string
    id string
    keyServerPriority number
    (Integer) Used in the MACsec Key Agreement (MKA) protocol to determine which peer acts as the key server. Lower values indicate a higher preference to be the key server. The MACsec configuration on the direct link will always set this value to 255.
    sakRekeys GetDlGatewayMacsecConfigSakRekey[]
    (List) Determines how SAK rekeying occurs. It is either timer based or based on the amount of used packet numbers. Nested scheme for sak_rekey:
    securityPolicy string
    (String) Determines how packets without MACsec headers are handled. must_secure - Packets without MACsec headers are dropped. This policy should be used to prefer security over network availability. should_secure - Packets without MACsec headers are allowed. This policy should be used to prefer network availability over security.
    status string
    (String) Current status of MACsec on this direct link. Status offline is returned when MACsec is inactive and during direct link creation. Status deleting is returned when MACsec during removal of MACsec from the direct link and during direct link deletion. See status_reasons[] for possible remediation of the failed status.
    statusReasons GetDlGatewayMacsecConfigStatusReason[]
    (List) Context for certain values of status. Nested Schema for status_reasons:
    updatedAt string
    (String) The date and time the resource was last updated.
    windowSize number
    (Integer) The window size determines the number of frames in a window for replay protection. Replay protection is used to counter replay attacks. Frames within a window size can be out of order and are not replay protected.
    active bool
    (Bool) Indicates if the MACsec feature is currently active (true) or inactive (false) for a gateway.
    cipher_suite str
    (String) The cipher suite used in generating the security association key (SAK).
    confidentiality_offset float
    (Integer) The confidentiality offset determines the number of octets in an Ethernet frame that are not encrypted.
    created_at str
    (String) The date and time the resource was created.
    gateway str
    id str
    key_server_priority float
    (Integer) Used in the MACsec Key Agreement (MKA) protocol to determine which peer acts as the key server. Lower values indicate a higher preference to be the key server. The MACsec configuration on the direct link will always set this value to 255.
    sak_rekeys Sequence[GetDlGatewayMacsecConfigSakRekey]
    (List) Determines how SAK rekeying occurs. It is either timer based or based on the amount of used packet numbers. Nested scheme for sak_rekey:
    security_policy str
    (String) Determines how packets without MACsec headers are handled. must_secure - Packets without MACsec headers are dropped. This policy should be used to prefer security over network availability. should_secure - Packets without MACsec headers are allowed. This policy should be used to prefer network availability over security.
    status str
    (String) Current status of MACsec on this direct link. Status offline is returned when MACsec is inactive and during direct link creation. Status deleting is returned when MACsec during removal of MACsec from the direct link and during direct link deletion. See status_reasons[] for possible remediation of the failed status.
    status_reasons Sequence[GetDlGatewayMacsecConfigStatusReason]
    (List) Context for certain values of status. Nested Schema for status_reasons:
    updated_at str
    (String) The date and time the resource was last updated.
    window_size float
    (Integer) The window size determines the number of frames in a window for replay protection. Replay protection is used to counter replay attacks. Frames within a window size can be out of order and are not replay protected.
    active Boolean
    (Bool) Indicates if the MACsec feature is currently active (true) or inactive (false) for a gateway.
    cipherSuite String
    (String) The cipher suite used in generating the security association key (SAK).
    confidentialityOffset Number
    (Integer) The confidentiality offset determines the number of octets in an Ethernet frame that are not encrypted.
    createdAt String
    (String) The date and time the resource was created.
    gateway String
    id String
    keyServerPriority Number
    (Integer) Used in the MACsec Key Agreement (MKA) protocol to determine which peer acts as the key server. Lower values indicate a higher preference to be the key server. The MACsec configuration on the direct link will always set this value to 255.
    sakRekeys List<Property Map>
    (List) Determines how SAK rekeying occurs. It is either timer based or based on the amount of used packet numbers. Nested scheme for sak_rekey:
    securityPolicy String
    (String) Determines how packets without MACsec headers are handled. must_secure - Packets without MACsec headers are dropped. This policy should be used to prefer security over network availability. should_secure - Packets without MACsec headers are allowed. This policy should be used to prefer network availability over security.
    status String
    (String) Current status of MACsec on this direct link. Status offline is returned when MACsec is inactive and during direct link creation. Status deleting is returned when MACsec during removal of MACsec from the direct link and during direct link deletion. See status_reasons[] for possible remediation of the failed status.
    statusReasons List<Property Map>
    (List) Context for certain values of status. Nested Schema for status_reasons:
    updatedAt String
    (String) The date and time the resource was last updated.
    windowSize Number
    (Integer) The window size determines the number of frames in a window for replay protection. Replay protection is used to counter replay attacks. Frames within a window size can be out of order and are not replay protected.

    Supporting Types

    GetDlGatewayMacsecConfigSakRekey

    Interval double
    (Integer) The time, in seconds, to force a Secure Association Key (SAK) rekey.
    Mode string
    (String) Determines that the SAK rekey occurs based on a timer.
    Interval float64
    (Integer) The time, in seconds, to force a Secure Association Key (SAK) rekey.
    Mode string
    (String) Determines that the SAK rekey occurs based on a timer.
    interval Double
    (Integer) The time, in seconds, to force a Secure Association Key (SAK) rekey.
    mode String
    (String) Determines that the SAK rekey occurs based on a timer.
    interval number
    (Integer) The time, in seconds, to force a Secure Association Key (SAK) rekey.
    mode string
    (String) Determines that the SAK rekey occurs based on a timer.
    interval float
    (Integer) The time, in seconds, to force a Secure Association Key (SAK) rekey.
    mode str
    (String) Determines that the SAK rekey occurs based on a timer.
    interval Number
    (Integer) The time, in seconds, to force a Secure Association Key (SAK) rekey.
    mode String
    (String) Determines that the SAK rekey occurs based on a timer.

    GetDlGatewayMacsecConfigStatusReason

    GetDlGatewayMacsecConfigStatusReasonSakRekeyTimerMode

    Code string
    (String) A reason code for the status: macsec_cak_failed - At least one of the connectivity association keys (CAKs) associated with the MACsec configuration was unable to be configured on the direct link gateway. Refer to the status of the CAKs associated with the MACsec configuration to find the the source of this reason.
    Message string
    (String) An explanation of the status reason.
    MoreInfo string
    (String) Link to documentation about this status reason.
    Code string
    (String) A reason code for the status: macsec_cak_failed - At least one of the connectivity association keys (CAKs) associated with the MACsec configuration was unable to be configured on the direct link gateway. Refer to the status of the CAKs associated with the MACsec configuration to find the the source of this reason.
    Message string
    (String) An explanation of the status reason.
    MoreInfo string
    (String) Link to documentation about this status reason.
    code String
    (String) A reason code for the status: macsec_cak_failed - At least one of the connectivity association keys (CAKs) associated with the MACsec configuration was unable to be configured on the direct link gateway. Refer to the status of the CAKs associated with the MACsec configuration to find the the source of this reason.
    message String
    (String) An explanation of the status reason.
    moreInfo String
    (String) Link to documentation about this status reason.
    code string
    (String) A reason code for the status: macsec_cak_failed - At least one of the connectivity association keys (CAKs) associated with the MACsec configuration was unable to be configured on the direct link gateway. Refer to the status of the CAKs associated with the MACsec configuration to find the the source of this reason.
    message string
    (String) An explanation of the status reason.
    moreInfo string
    (String) Link to documentation about this status reason.
    code str
    (String) A reason code for the status: macsec_cak_failed - At least one of the connectivity association keys (CAKs) associated with the MACsec configuration was unable to be configured on the direct link gateway. Refer to the status of the CAKs associated with the MACsec configuration to find the the source of this reason.
    message str
    (String) An explanation of the status reason.
    more_info str
    (String) Link to documentation about this status reason.
    code String
    (String) A reason code for the status: macsec_cak_failed - At least one of the connectivity association keys (CAKs) associated with the MACsec configuration was unable to be configured on the direct link gateway. Refer to the status of the CAKs associated with the MACsec configuration to find the the source of this reason.
    message String
    (String) An explanation of the status reason.
    moreInfo String
    (String) Link to documentation about this status reason.

    Package Details

    Repository
    ibm ibm-cloud/terraform-provider-ibm
    License
    Notes
    This Pulumi package is based on the ibm Terraform Provider.
    ibm logo
    ibm 1.80.0-beta0 published on Tuesday, Jun 24, 2025 by ibm-cloud
    ibm-cloud/terraform-provider-ibm