1. Packages
  2. Cisco Meraki Provider
  3. API Docs
  4. networks
  5. getSettings
Cisco Meraki v0.4.1 published on Saturday, Mar 15, 2025 by Pulumi

meraki.networks.getSettings

Explore with Pulumi AI

Cisco Meraki v0.4.1 published on Saturday, Mar 15, 2025 by Pulumi

Example Usage

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

const example = meraki.networks.getSettings({
    networkId: "string",
});
export const merakiNetworksSettingsExample = example.then(example => example.item);
Copy
import pulumi
import pulumi_meraki as meraki

example = meraki.networks.get_settings(network_id="string")
pulumi.export("merakiNetworksSettingsExample", example.item)
Copy
package main

import (
	"github.com/pulumi/pulumi-meraki/sdk/go/meraki/networks"
	"github.com/pulumi/pulumi/sdk/v3/go/pulumi"
)

func main() {
	pulumi.Run(func(ctx *pulumi.Context) error {
		example, err := networks.LookupSettings(ctx, &networks.LookupSettingsArgs{
			NetworkId: "string",
		}, nil)
		if err != nil {
			return err
		}
		ctx.Export("merakiNetworksSettingsExample", example.Item)
		return nil
	})
}
Copy
using System.Collections.Generic;
using System.Linq;
using Pulumi;
using Meraki = Pulumi.Meraki;

return await Deployment.RunAsync(() => 
{
    var example = Meraki.Networks.GetSettings.Invoke(new()
    {
        NetworkId = "string",
    });

    return new Dictionary<string, object?>
    {
        ["merakiNetworksSettingsExample"] = example.Apply(getSettingsResult => getSettingsResult.Item),
    };
});
Copy
package generated_program;

import com.pulumi.Context;
import com.pulumi.Pulumi;
import com.pulumi.core.Output;
import com.pulumi.meraki.networks.NetworksFunctions;
import com.pulumi.meraki.networks.inputs.GetSettingsArgs;
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 = NetworksFunctions.getSettings(GetSettingsArgs.builder()
            .networkId("string")
            .build());

        ctx.export("merakiNetworksSettingsExample", example.applyValue(getSettingsResult -> getSettingsResult.item()));
    }
}
Copy
variables:
  example:
    fn::invoke:
      function: meraki:networks:getSettings
      arguments:
        networkId: string
outputs:
  merakiNetworksSettingsExample: ${example.item}
Copy

Using getSettings

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 getSettings(args: GetSettingsArgs, opts?: InvokeOptions): Promise<GetSettingsResult>
function getSettingsOutput(args: GetSettingsOutputArgs, opts?: InvokeOptions): Output<GetSettingsResult>
Copy
def get_settings(network_id: Optional[str] = None,
                 opts: Optional[InvokeOptions] = None) -> GetSettingsResult
def get_settings_output(network_id: Optional[pulumi.Input[str]] = None,
                 opts: Optional[InvokeOptions] = None) -> Output[GetSettingsResult]
Copy
func LookupSettings(ctx *Context, args *LookupSettingsArgs, opts ...InvokeOption) (*LookupSettingsResult, error)
func LookupSettingsOutput(ctx *Context, args *LookupSettingsOutputArgs, opts ...InvokeOption) LookupSettingsResultOutput
Copy

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

public static class GetSettings 
{
    public static Task<GetSettingsResult> InvokeAsync(GetSettingsArgs args, InvokeOptions? opts = null)
    public static Output<GetSettingsResult> Invoke(GetSettingsInvokeArgs args, InvokeOptions? opts = null)
}
Copy
public static CompletableFuture<GetSettingsResult> getSettings(GetSettingsArgs args, InvokeOptions options)
public static Output<GetSettingsResult> getSettings(GetSettingsArgs args, InvokeOptions options)
Copy
fn::invoke:
  function: meraki:networks/getSettings:getSettings
  arguments:
    # arguments dictionary
Copy

The following arguments are supported:

NetworkId This property is required. string
networkId path parameter. Network ID
NetworkId This property is required. string
networkId path parameter. Network ID
networkId This property is required. String
networkId path parameter. Network ID
networkId This property is required. string
networkId path parameter. Network ID
network_id This property is required. str
networkId path parameter. Network ID
networkId This property is required. String
networkId path parameter. Network ID

getSettings Result

The following output properties are available:

Id string
The provider-assigned unique ID for this managed resource.
Item GetSettingsItem
NetworkId string
networkId path parameter. Network ID
Id string
The provider-assigned unique ID for this managed resource.
Item GetSettingsItem
NetworkId string
networkId path parameter. Network ID
id String
The provider-assigned unique ID for this managed resource.
item GetSettingsItem
networkId String
networkId path parameter. Network ID
id string
The provider-assigned unique ID for this managed resource.
item GetSettingsItem
networkId string
networkId path parameter. Network ID
id str
The provider-assigned unique ID for this managed resource.
item GetSettingsItem
network_id str
networkId path parameter. Network ID
id String
The provider-assigned unique ID for this managed resource.
item Property Map
networkId String
networkId path parameter. Network ID

Supporting Types

GetSettingsItem

Fips This property is required. GetSettingsItemFips
A hash of FIPS options applied to the Network
LocalStatusPage This property is required. GetSettingsItemLocalStatusPage
A hash of Local Status page(s)' authentication options applied to the Network.
LocalStatusPageEnabled This property is required. bool
Enables / disables the local device status pages (\n\nmy.meraki.com, \n\n\n\nap.meraki.com, \n\n\n\nswitch.meraki.com, \n\n\n\nwired.meraki.com\n\n). Optional (defaults to false)
NamedVlans This property is required. GetSettingsItemNamedVlans
A hash of Named VLANs options applied to the Network.
RemoteStatusPageEnabled This property is required. bool
Enables / disables access to the device status page (\n\nhttp://[device's LAN IP])\n\n. Optional. Can only be set if localStatusPageEnabled is set to true
SecurePort This property is required. GetSettingsItemSecurePort
A hash of SecureConnect options applied to the Network.
Fips This property is required. GetSettingsItemFips
A hash of FIPS options applied to the Network
LocalStatusPage This property is required. GetSettingsItemLocalStatusPage
A hash of Local Status page(s)' authentication options applied to the Network.
LocalStatusPageEnabled This property is required. bool
Enables / disables the local device status pages (\n\nmy.meraki.com, \n\n\n\nap.meraki.com, \n\n\n\nswitch.meraki.com, \n\n\n\nwired.meraki.com\n\n). Optional (defaults to false)
NamedVlans This property is required. GetSettingsItemNamedVlans
A hash of Named VLANs options applied to the Network.
RemoteStatusPageEnabled This property is required. bool
Enables / disables access to the device status page (\n\nhttp://[device's LAN IP])\n\n. Optional. Can only be set if localStatusPageEnabled is set to true
SecurePort This property is required. GetSettingsItemSecurePort
A hash of SecureConnect options applied to the Network.
fips This property is required. GetSettingsItemFips
A hash of FIPS options applied to the Network
localStatusPage This property is required. GetSettingsItemLocalStatusPage
A hash of Local Status page(s)' authentication options applied to the Network.
localStatusPageEnabled This property is required. Boolean
Enables / disables the local device status pages (\n\nmy.meraki.com, \n\n\n\nap.meraki.com, \n\n\n\nswitch.meraki.com, \n\n\n\nwired.meraki.com\n\n). Optional (defaults to false)
namedVlans This property is required. GetSettingsItemNamedVlans
A hash of Named VLANs options applied to the Network.
remoteStatusPageEnabled This property is required. Boolean
Enables / disables access to the device status page (\n\nhttp://[device's LAN IP])\n\n. Optional. Can only be set if localStatusPageEnabled is set to true
securePort This property is required. GetSettingsItemSecurePort
A hash of SecureConnect options applied to the Network.
fips This property is required. GetSettingsItemFips
A hash of FIPS options applied to the Network
localStatusPage This property is required. GetSettingsItemLocalStatusPage
A hash of Local Status page(s)' authentication options applied to the Network.
localStatusPageEnabled This property is required. boolean
Enables / disables the local device status pages (\n\nmy.meraki.com, \n\n\n\nap.meraki.com, \n\n\n\nswitch.meraki.com, \n\n\n\nwired.meraki.com\n\n). Optional (defaults to false)
namedVlans This property is required. GetSettingsItemNamedVlans
A hash of Named VLANs options applied to the Network.
remoteStatusPageEnabled This property is required. boolean
Enables / disables access to the device status page (\n\nhttp://[device's LAN IP])\n\n. Optional. Can only be set if localStatusPageEnabled is set to true
securePort This property is required. GetSettingsItemSecurePort
A hash of SecureConnect options applied to the Network.
fips This property is required. GetSettingsItemFips
A hash of FIPS options applied to the Network
local_status_page This property is required. GetSettingsItemLocalStatusPage
A hash of Local Status page(s)' authentication options applied to the Network.
local_status_page_enabled This property is required. bool
Enables / disables the local device status pages (\n\nmy.meraki.com, \n\n\n\nap.meraki.com, \n\n\n\nswitch.meraki.com, \n\n\n\nwired.meraki.com\n\n). Optional (defaults to false)
named_vlans This property is required. GetSettingsItemNamedVlans
A hash of Named VLANs options applied to the Network.
remote_status_page_enabled This property is required. bool
Enables / disables access to the device status page (\n\nhttp://[device's LAN IP])\n\n. Optional. Can only be set if localStatusPageEnabled is set to true
secure_port This property is required. GetSettingsItemSecurePort
A hash of SecureConnect options applied to the Network.
fips This property is required. Property Map
A hash of FIPS options applied to the Network
localStatusPage This property is required. Property Map
A hash of Local Status page(s)' authentication options applied to the Network.
localStatusPageEnabled This property is required. Boolean
Enables / disables the local device status pages (\n\nmy.meraki.com, \n\n\n\nap.meraki.com, \n\n\n\nswitch.meraki.com, \n\n\n\nwired.meraki.com\n\n). Optional (defaults to false)
namedVlans This property is required. Property Map
A hash of Named VLANs options applied to the Network.
remoteStatusPageEnabled This property is required. Boolean
Enables / disables access to the device status page (\n\nhttp://[device's LAN IP])\n\n. Optional. Can only be set if localStatusPageEnabled is set to true
securePort This property is required. Property Map
A hash of SecureConnect options applied to the Network.

GetSettingsItemFips

Enabled This property is required. bool
Enables / disables FIPS on the network.
Enabled This property is required. bool
Enables / disables FIPS on the network.
enabled This property is required. Boolean
Enables / disables FIPS on the network.
enabled This property is required. boolean
Enables / disables FIPS on the network.
enabled This property is required. bool
Enables / disables FIPS on the network.
enabled This property is required. Boolean
Enables / disables FIPS on the network.

GetSettingsItemLocalStatusPage

Authentication This property is required. GetSettingsItemLocalStatusPageAuthentication
A hash of Local Status page(s)' authentication options applied to the Network.
Authentication This property is required. GetSettingsItemLocalStatusPageAuthentication
A hash of Local Status page(s)' authentication options applied to the Network.
authentication This property is required. GetSettingsItemLocalStatusPageAuthentication
A hash of Local Status page(s)' authentication options applied to the Network.
authentication This property is required. GetSettingsItemLocalStatusPageAuthentication
A hash of Local Status page(s)' authentication options applied to the Network.
authentication This property is required. GetSettingsItemLocalStatusPageAuthentication
A hash of Local Status page(s)' authentication options applied to the Network.
authentication This property is required. Property Map
A hash of Local Status page(s)' authentication options applied to the Network.

GetSettingsItemLocalStatusPageAuthentication

Enabled This property is required. bool
Enables / disables the authentication on Local Status page(s).
Username This property is required. string
The username used for Local Status Page(s).
Enabled This property is required. bool
Enables / disables the authentication on Local Status page(s).
Username This property is required. string
The username used for Local Status Page(s).
enabled This property is required. Boolean
Enables / disables the authentication on Local Status page(s).
username This property is required. String
The username used for Local Status Page(s).
enabled This property is required. boolean
Enables / disables the authentication on Local Status page(s).
username This property is required. string
The username used for Local Status Page(s).
enabled This property is required. bool
Enables / disables the authentication on Local Status page(s).
username This property is required. str
The username used for Local Status Page(s).
enabled This property is required. Boolean
Enables / disables the authentication on Local Status page(s).
username This property is required. String
The username used for Local Status Page(s).

GetSettingsItemNamedVlans

Enabled This property is required. bool
Enables / disables Named VLANs on the Network.
Enabled This property is required. bool
Enables / disables Named VLANs on the Network.
enabled This property is required. Boolean
Enables / disables Named VLANs on the Network.
enabled This property is required. boolean
Enables / disables Named VLANs on the Network.
enabled This property is required. bool
Enables / disables Named VLANs on the Network.
enabled This property is required. Boolean
Enables / disables Named VLANs on the Network.

GetSettingsItemSecurePort

Enabled This property is required. bool
Enables / disables SecureConnect on the network. Optional.
Enabled This property is required. bool
Enables / disables SecureConnect on the network. Optional.
enabled This property is required. Boolean
Enables / disables SecureConnect on the network. Optional.
enabled This property is required. boolean
Enables / disables SecureConnect on the network. Optional.
enabled This property is required. bool
Enables / disables SecureConnect on the network. Optional.
enabled This property is required. Boolean
Enables / disables SecureConnect on the network. Optional.

Package Details

Repository
meraki pulumi/pulumi-meraki
License
Apache-2.0
Notes
This Pulumi package is based on the meraki Terraform Provider.
Cisco Meraki v0.4.1 published on Saturday, Mar 15, 2025 by Pulumi