1. Packages
  2. Cisco IOS XE Resource Provider
  3. API Docs
  4. getMdtSubscription
Cisco IOS XE v0.0.1 published on Friday, Sep 22, 2023 by lbrlabs

iosxe.getMdtSubscription

Explore with Pulumi AI

iosxe logo
Cisco IOS XE v0.0.1 published on Friday, Sep 22, 2023 by lbrlabs

    This data source can read the MDT Subscription configuration.

    Example Usage

    using System.Collections.Generic;
    using System.Linq;
    using Pulumi;
    using Iosxe = Pulumi.Iosxe;
    
    return await Deployment.RunAsync(() => 
    {
        var example = Iosxe.GetMdtSubscription.Invoke(new()
        {
            SubscriptionId = 101,
        });
    
    });
    
    package main
    
    import (
    	"github.com/lbrlabs/pulumi-iosxe/sdk/go/iosxe"
    	"github.com/pulumi/pulumi/sdk/v3/go/pulumi"
    )
    
    func main() {
    	pulumi.Run(func(ctx *pulumi.Context) error {
    		_, err := iosxe.LookupMdtSubscription(ctx, &iosxe.LookupMdtSubscriptionArgs{
    			SubscriptionId: 101,
    		}, nil)
    		if err != nil {
    			return err
    		}
    		return nil
    	})
    }
    
    package generated_program;
    
    import com.pulumi.Context;
    import com.pulumi.Pulumi;
    import com.pulumi.core.Output;
    import com.pulumi.iosxe.IosxeFunctions;
    import com.pulumi.iosxe.inputs.GetMdtSubscriptionArgs;
    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 example = IosxeFunctions.getMdtSubscription(GetMdtSubscriptionArgs.builder()
                .subscriptionId(101)
                .build());
    
        }
    }
    
    import pulumi
    import pulumi_iosxe as iosxe
    
    example = iosxe.get_mdt_subscription(subscription_id=101)
    
    import * as pulumi from "@pulumi/pulumi";
    import * as iosxe from "@pulumi/iosxe";
    
    const example = iosxe.getMdtSubscription({
        subscriptionId: 101,
    });
    
    variables:
      example:
        fn::invoke:
          Function: iosxe:getMdtSubscription
          Arguments:
            subscriptionId: 101
    

    Using getMdtSubscription

    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 getMdtSubscription(args: GetMdtSubscriptionArgs, opts?: InvokeOptions): Promise<GetMdtSubscriptionResult>
    function getMdtSubscriptionOutput(args: GetMdtSubscriptionOutputArgs, opts?: InvokeOptions): Output<GetMdtSubscriptionResult>
    def get_mdt_subscription(device: Optional[str] = None,
                             subscription_id: Optional[int] = None,
                             opts: Optional[InvokeOptions] = None) -> GetMdtSubscriptionResult
    def get_mdt_subscription_output(device: Optional[pulumi.Input[str]] = None,
                             subscription_id: Optional[pulumi.Input[int]] = None,
                             opts: Optional[InvokeOptions] = None) -> Output[GetMdtSubscriptionResult]
    func LookupMdtSubscription(ctx *Context, args *LookupMdtSubscriptionArgs, opts ...InvokeOption) (*LookupMdtSubscriptionResult, error)
    func LookupMdtSubscriptionOutput(ctx *Context, args *LookupMdtSubscriptionOutputArgs, opts ...InvokeOption) LookupMdtSubscriptionResultOutput

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

    public static class GetMdtSubscription 
    {
        public static Task<GetMdtSubscriptionResult> InvokeAsync(GetMdtSubscriptionArgs args, InvokeOptions? opts = null)
        public static Output<GetMdtSubscriptionResult> Invoke(GetMdtSubscriptionInvokeArgs args, InvokeOptions? opts = null)
    }
    public static CompletableFuture<GetMdtSubscriptionResult> getMdtSubscription(GetMdtSubscriptionArgs args, InvokeOptions options)
    // Output-based functions aren't available in Java yet
    
    fn::invoke:
      function: iosxe:index/getMdtSubscription:getMdtSubscription
      arguments:
        # arguments dictionary

    The following arguments are supported:

    SubscriptionId int
    Unique subscription identifier.
    Device string
    A device name from the provider configuration.
    SubscriptionId int
    Unique subscription identifier.
    Device string
    A device name from the provider configuration.
    subscriptionId Integer
    Unique subscription identifier.
    device String
    A device name from the provider configuration.
    subscriptionId number
    Unique subscription identifier.
    device string
    A device name from the provider configuration.
    subscription_id int
    Unique subscription identifier.
    device str
    A device name from the provider configuration.
    subscriptionId Number
    Unique subscription identifier.
    device String
    A device name from the provider configuration.

    getMdtSubscription Result

    The following output properties are available:

    Encoding string
    Update notification encoding
    FilterXpath string
    XPath expression describing the set of objects wanted as part of the subscription
    Id string
    The path of the retrieved object.
    Receivers List<Lbrlabs.PulumiPackage.Iosxe.Outputs.GetMdtSubscriptionReceiver>
    Configuration of receivers of configured subscriptions. Use of this is deprecated. Use mdt-receiver-names instead.
    SourceAddress string
    The source address for the notifications
    SourceVrf string
    Network instance name for the VRF
    Stream string
    The name of the event stream being subscribed to
    SubscriptionId int
    Unique subscription identifier.
    UpdatePolicyOnChange bool
    If true, there is no initial update notification with the current value of all the data. NOT CURRENTLY SUPPORTED. If specified, must be false
    UpdatePolicyPeriodic int
    Period of update notifications in hundredths of a second
    Device string
    A device name from the provider configuration.
    Encoding string
    Update notification encoding
    FilterXpath string
    XPath expression describing the set of objects wanted as part of the subscription
    Id string
    The path of the retrieved object.
    Receivers []GetMdtSubscriptionReceiver
    Configuration of receivers of configured subscriptions. Use of this is deprecated. Use mdt-receiver-names instead.
    SourceAddress string
    The source address for the notifications
    SourceVrf string
    Network instance name for the VRF
    Stream string
    The name of the event stream being subscribed to
    SubscriptionId int
    Unique subscription identifier.
    UpdatePolicyOnChange bool
    If true, there is no initial update notification with the current value of all the data. NOT CURRENTLY SUPPORTED. If specified, must be false
    UpdatePolicyPeriodic int
    Period of update notifications in hundredths of a second
    Device string
    A device name from the provider configuration.
    encoding String
    Update notification encoding
    filterXpath String
    XPath expression describing the set of objects wanted as part of the subscription
    id String
    The path of the retrieved object.
    receivers List<GetMdtSubscriptionReceiver>
    Configuration of receivers of configured subscriptions. Use of this is deprecated. Use mdt-receiver-names instead.
    sourceAddress String
    The source address for the notifications
    sourceVrf String
    Network instance name for the VRF
    stream String
    The name of the event stream being subscribed to
    subscriptionId Integer
    Unique subscription identifier.
    updatePolicyOnChange Boolean
    If true, there is no initial update notification with the current value of all the data. NOT CURRENTLY SUPPORTED. If specified, must be false
    updatePolicyPeriodic Integer
    Period of update notifications in hundredths of a second
    device String
    A device name from the provider configuration.
    encoding string
    Update notification encoding
    filterXpath string
    XPath expression describing the set of objects wanted as part of the subscription
    id string
    The path of the retrieved object.
    receivers GetMdtSubscriptionReceiver[]
    Configuration of receivers of configured subscriptions. Use of this is deprecated. Use mdt-receiver-names instead.
    sourceAddress string
    The source address for the notifications
    sourceVrf string
    Network instance name for the VRF
    stream string
    The name of the event stream being subscribed to
    subscriptionId number
    Unique subscription identifier.
    updatePolicyOnChange boolean
    If true, there is no initial update notification with the current value of all the data. NOT CURRENTLY SUPPORTED. If specified, must be false
    updatePolicyPeriodic number
    Period of update notifications in hundredths of a second
    device string
    A device name from the provider configuration.
    encoding str
    Update notification encoding
    filter_xpath str
    XPath expression describing the set of objects wanted as part of the subscription
    id str
    The path of the retrieved object.
    receivers Sequence[GetMdtSubscriptionReceiver]
    Configuration of receivers of configured subscriptions. Use of this is deprecated. Use mdt-receiver-names instead.
    source_address str
    The source address for the notifications
    source_vrf str
    Network instance name for the VRF
    stream str
    The name of the event stream being subscribed to
    subscription_id int
    Unique subscription identifier.
    update_policy_on_change bool
    If true, there is no initial update notification with the current value of all the data. NOT CURRENTLY SUPPORTED. If specified, must be false
    update_policy_periodic int
    Period of update notifications in hundredths of a second
    device str
    A device name from the provider configuration.
    encoding String
    Update notification encoding
    filterXpath String
    XPath expression describing the set of objects wanted as part of the subscription
    id String
    The path of the retrieved object.
    receivers List<Property Map>
    Configuration of receivers of configured subscriptions. Use of this is deprecated. Use mdt-receiver-names instead.
    sourceAddress String
    The source address for the notifications
    sourceVrf String
    Network instance name for the VRF
    stream String
    The name of the event stream being subscribed to
    subscriptionId Number
    Unique subscription identifier.
    updatePolicyOnChange Boolean
    If true, there is no initial update notification with the current value of all the data. NOT CURRENTLY SUPPORTED. If specified, must be false
    updatePolicyPeriodic Number
    Period of update notifications in hundredths of a second
    device String
    A device name from the provider configuration.

    Supporting Types

    GetMdtSubscriptionReceiver

    Address string
    IP address of the receiver
    Port int
    Network port of the receiver
    Protocol string
    Receiver transport protocol.
    Address string
    IP address of the receiver
    Port int
    Network port of the receiver
    Protocol string
    Receiver transport protocol.
    address String
    IP address of the receiver
    port Integer
    Network port of the receiver
    protocol String
    Receiver transport protocol.
    address string
    IP address of the receiver
    port number
    Network port of the receiver
    protocol string
    Receiver transport protocol.
    address str
    IP address of the receiver
    port int
    Network port of the receiver
    protocol str
    Receiver transport protocol.
    address String
    IP address of the receiver
    port Number
    Network port of the receiver
    protocol String
    Receiver transport protocol.

    Package Details

    Repository
    iosxe lbrlabs/pulumi-iosxe
    License
    Apache-2.0
    Notes
    This Pulumi package is based on the iosxe Terraform Provider.
    iosxe logo
    Cisco IOS XE v0.0.1 published on Friday, Sep 22, 2023 by lbrlabs