1. Packages
  2. Cisco IOS XE Resource Provider
  3. API Docs
  4. getSystem
Viewing docs for Cisco IOS XE v0.0.1
published on Friday, Sep 22, 2023 by lbrlabs
Schema (JSON)
lbrlabs/pulumi-iosxe

iosxe.getSystem

iosxe logo
Viewing docs for Cisco IOS XE v0.0.1
published on Friday, Sep 22, 2023 by lbrlabs
Schema (JSON)
lbrlabs/pulumi-iosxe

    This data source can read the System configuration.

    Example Usage

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

return await Deployment.RunAsync(() => 
{
    var example = Iosxe.GetSystem.Invoke();

});

    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.LookupSystem(ctx, nil, 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.GetSystemArgs;
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.getSystem();

    }
}

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

const example = iosxe.getSystem({});

    import pulumi
import pulumi_iosxe as iosxe

example = iosxe.get_system()

    variables:
  example:
    fn::invoke:
      Function: iosxe:getSystem
      Arguments: {}

    Using getSystem

    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 getSystem(args: GetSystemArgs, opts?: InvokeOptions): Promise<GetSystemResult>
function getSystemOutput(args: GetSystemOutputArgs, opts?: InvokeOptions): Output<GetSystemResult>
    def get_system(device: Optional[str] = None,
               opts: Optional[InvokeOptions] = None) -> GetSystemResult
def get_system_output(device: Optional[pulumi.Input[str]] = None,
               opts: Optional[InvokeOptions] = None) -> Output[GetSystemResult]
    func LookupSystem(ctx *Context, args *LookupSystemArgs, opts ...InvokeOption) (*LookupSystemResult, error)
func LookupSystemOutput(ctx *Context, args *LookupSystemOutputArgs, opts ...InvokeOption) LookupSystemResultOutput

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

    public static class GetSystem 
{
    public static Task<GetSystemResult> InvokeAsync(GetSystemArgs args, InvokeOptions? opts = null)
    public static Output<GetSystemResult> Invoke(GetSystemInvokeArgs args, InvokeOptions? opts = null)
}
    public static CompletableFuture<GetSystemResult> getSystem(GetSystemArgs args, InvokeOptions options)
public static Output<GetSystemResult> getSystem(GetSystemArgs args, InvokeOptions options)

    fn::invoke:
  function: iosxe:index/getSystem:getSystem
  arguments:
    # arguments dictionary

    The following arguments are supported:

    Device string
    A device name from the provider configuration.
    Device string
    A device name from the provider configuration.
    device String
    A device name from the provider configuration.
    device string
    A device name from the provider configuration.
    device str
    A device name from the provider configuration.
    device String
    A device name from the provider configuration.

    getSystem Result

    The following output properties are available:

    Hostname string
    Set system's network name
    Id string
    The path of the retrieved object.
    IpDomainLookup bool
    Enable IP Domain Name System hostname translation
    IpDomainName string
    Define the default domain name
    IpMulticastRouting bool
    Enable IP multicast forwarding
    IpMulticastRoutingDistributed bool
    Distributed multicast switching
    IpRouting bool
    Enable or disable IP routing
    IpSourceRoute bool
    Process packets with source routing header options
    Ipv6UnicastRouting bool
    Enable unicast routing
    LoginDelay int
    Set delay between successive fail login
    LoginOnFailure bool
    Set options for failed login attempt
    LoginOnFailureLog bool
    Generate syslogs on failure logins
    LoginOnSuccess bool
    Set options for successful login attempt
    LoginOnSuccessLog bool
    Generate syslogs on successful logins
    Mtu int
    MulticastRoutingSwitch bool
    Enable IP multicast forwarding, some XE devices use this option instead of multicast_routing.
    MulticastRoutingVrfs List<Lbrlabs.PulumiPackage.Iosxe.Outputs.GetSystemMulticastRoutingVrf>
    Select VPN Routing/Forwarding instance
    Device string
    A device name from the provider configuration.
    Hostname string
    Set system's network name
    Id string
    The path of the retrieved object.
    IpDomainLookup bool
    Enable IP Domain Name System hostname translation
    IpDomainName string
    Define the default domain name
    IpMulticastRouting bool
    Enable IP multicast forwarding
    IpMulticastRoutingDistributed bool
    Distributed multicast switching
    IpRouting bool
    Enable or disable IP routing
    IpSourceRoute bool
    Process packets with source routing header options
    Ipv6UnicastRouting bool
    Enable unicast routing
    LoginDelay int
    Set delay between successive fail login
    LoginOnFailure bool
    Set options for failed login attempt
    LoginOnFailureLog bool
    Generate syslogs on failure logins
    LoginOnSuccess bool
    Set options for successful login attempt
    LoginOnSuccessLog bool
    Generate syslogs on successful logins
    Mtu int
    MulticastRoutingSwitch bool
    Enable IP multicast forwarding, some XE devices use this option instead of multicast_routing.
    MulticastRoutingVrfs []GetSystemMulticastRoutingVrf
    Select VPN Routing/Forwarding instance
    Device string
    A device name from the provider configuration.
    hostname String
    Set system's network name
    id String
    The path of the retrieved object.
    ipDomainLookup Boolean
    Enable IP Domain Name System hostname translation
    ipDomainName String
    Define the default domain name
    ipMulticastRouting Boolean
    Enable IP multicast forwarding
    ipMulticastRoutingDistributed Boolean
    Distributed multicast switching
    ipRouting Boolean
    Enable or disable IP routing
    ipSourceRoute Boolean
    Process packets with source routing header options
    ipv6UnicastRouting Boolean
    Enable unicast routing
    loginDelay Integer
    Set delay between successive fail login
    loginOnFailure Boolean
    Set options for failed login attempt
    loginOnFailureLog Boolean
    Generate syslogs on failure logins
    loginOnSuccess Boolean
    Set options for successful login attempt
    loginOnSuccessLog Boolean
    Generate syslogs on successful logins
    mtu Integer
    multicastRoutingSwitch Boolean
    Enable IP multicast forwarding, some XE devices use this option instead of multicast_routing.
    multicastRoutingVrfs List<GetSystemMulticastRoutingVrf>
    Select VPN Routing/Forwarding instance
    device String
    A device name from the provider configuration.
    hostname string
    Set system's network name
    id string
    The path of the retrieved object.
    ipDomainLookup boolean
    Enable IP Domain Name System hostname translation
    ipDomainName string
    Define the default domain name
    ipMulticastRouting boolean
    Enable IP multicast forwarding
    ipMulticastRoutingDistributed boolean
    Distributed multicast switching
    ipRouting boolean
    Enable or disable IP routing
    ipSourceRoute boolean
    Process packets with source routing header options
    ipv6UnicastRouting boolean
    Enable unicast routing
    loginDelay number
    Set delay between successive fail login
    loginOnFailure boolean
    Set options for failed login attempt
    loginOnFailureLog boolean
    Generate syslogs on failure logins
    loginOnSuccess boolean
    Set options for successful login attempt
    loginOnSuccessLog boolean
    Generate syslogs on successful logins
    mtu number
    multicastRoutingSwitch boolean
    Enable IP multicast forwarding, some XE devices use this option instead of multicast_routing.
    multicastRoutingVrfs GetSystemMulticastRoutingVrf[]
    Select VPN Routing/Forwarding instance
    device string
    A device name from the provider configuration.
    hostname str
    Set system's network name
    id str
    The path of the retrieved object.
    ip_domain_lookup bool
    Enable IP Domain Name System hostname translation
    ip_domain_name str
    Define the default domain name
    ip_multicast_routing bool
    Enable IP multicast forwarding
    ip_multicast_routing_distributed bool
    Distributed multicast switching
    ip_routing bool
    Enable or disable IP routing
    ip_source_route bool
    Process packets with source routing header options
    ipv6_unicast_routing bool
    Enable unicast routing
    login_delay int
    Set delay between successive fail login
    login_on_failure bool
    Set options for failed login attempt
    login_on_failure_log bool
    Generate syslogs on failure logins
    login_on_success bool
    Set options for successful login attempt
    login_on_success_log bool
    Generate syslogs on successful logins
    mtu int
    multicast_routing_switch bool
    Enable IP multicast forwarding, some XE devices use this option instead of multicast_routing.
    multicast_routing_vrfs Sequence[GetSystemMulticastRoutingVrf]
    Select VPN Routing/Forwarding instance
    device str
    A device name from the provider configuration.
    hostname String
    Set system's network name
    id String
    The path of the retrieved object.
    ipDomainLookup Boolean
    Enable IP Domain Name System hostname translation
    ipDomainName String
    Define the default domain name
    ipMulticastRouting Boolean
    Enable IP multicast forwarding
    ipMulticastRoutingDistributed Boolean
    Distributed multicast switching
    ipRouting Boolean
    Enable or disable IP routing
    ipSourceRoute Boolean
    Process packets with source routing header options
    ipv6UnicastRouting Boolean
    Enable unicast routing
    loginDelay Number
    Set delay between successive fail login
    loginOnFailure Boolean
    Set options for failed login attempt
    loginOnFailureLog Boolean
    Generate syslogs on failure logins
    loginOnSuccess Boolean
    Set options for successful login attempt
    loginOnSuccessLog Boolean
    Generate syslogs on successful logins
    mtu Number
    multicastRoutingSwitch Boolean
    Enable IP multicast forwarding, some XE devices use this option instead of multicast_routing.
    multicastRoutingVrfs List<Property Map>
    Select VPN Routing/Forwarding instance
    device String
    A device name from the provider configuration.

    Supporting Types

    GetSystemMulticastRoutingVrf

    Distributed bool
    Distributed multicast switching
    Vrf string
    Distributed bool
    Distributed multicast switching
    Vrf string
    distributed Boolean
    Distributed multicast switching
    vrf String
    distributed boolean
    Distributed multicast switching
    vrf string
    distributed bool
    Distributed multicast switching
    vrf str
    distributed Boolean
    Distributed multicast switching
    vrf String

    Package Details

    Repository
    iosxe lbrlabs/pulumi-iosxe
    License
    Apache-2.0
    Notes
    This Pulumi package is based on the iosxe Terraform Provider.
    iosxe logo
    Viewing docs for Cisco IOS XE v0.0.1
    published on Friday, Sep 22, 2023 by lbrlabs
    Schema (JSON)
    lbrlabs/pulumi-iosxe
      Try Pulumi Cloud free. Your team will thank you.