@pulumi/meraki
Version:
A Pulumi package for creating and managing Cisco Meraki resources. Based on terraform-provider-meraki: version v0.2.0
1,437 lines • 389 kB
TypeScript
import * as pulumi from "@pulumi/pulumi";
import * as inputs from "../types/input";
export declare namespace administered {
interface LicensingSubscriptionSubscriptionsBindItem {
/**
* Array of errors if failed
*/
errors?: pulumi.Input<pulumi.Input<string>[]>;
/**
* A list of entitlements required to successfully bind the networks to the subscription
*/
insufficientEntitlements?: pulumi.Input<pulumi.Input<inputs.administered.LicensingSubscriptionSubscriptionsBindItemInsufficientEntitlement>[]>;
/**
* Unbound networks
*/
networks?: pulumi.Input<pulumi.Input<inputs.administered.LicensingSubscriptionSubscriptionsBindItemNetwork>[]>;
/**
* Subscription ID
*/
subscriptionId?: pulumi.Input<string>;
}
interface LicensingSubscriptionSubscriptionsBindItemInsufficientEntitlement {
/**
* Number required
*/
quantity?: pulumi.Input<number>;
/**
* SKU of the required product
*/
sku?: pulumi.Input<string>;
}
interface LicensingSubscriptionSubscriptionsBindItemNetwork {
/**
* Network ID
*/
id?: pulumi.Input<string>;
/**
* Network name
*/
name?: pulumi.Input<string>;
}
interface LicensingSubscriptionSubscriptionsBindParameters {
/**
* List of network ids to bind to the subscription
*/
networkIds?: pulumi.Input<pulumi.Input<string>[]>;
}
interface LicensingSubscriptionSubscriptionsClaimItem {
/**
* Numeric breakdown of network and entitlement counts
*/
counts?: pulumi.Input<inputs.administered.LicensingSubscriptionSubscriptionsClaimItemCounts>;
/**
* Subscription description
*/
description?: pulumi.Input<string>;
/**
* Subscription expiration date
*/
endDate?: pulumi.Input<string>;
/**
* Entitlement info
*/
entitlements?: pulumi.Input<pulumi.Input<inputs.administered.LicensingSubscriptionSubscriptionsClaimItemEntitlement>[]>;
/**
* Subscription name
*/
name?: pulumi.Input<string>;
/**
* Products the subscription has entitlements for
*/
productTypes?: pulumi.Input<pulumi.Input<string>[]>;
/**
* Subscription start date
*/
startDate?: pulumi.Input<string>;
/**
* Subscription status
*/
status?: pulumi.Input<string>;
/**
* Subscription's ID
*/
subscriptionId?: pulumi.Input<string>;
/**
* Web order id
*/
webOrderId?: pulumi.Input<string>;
}
interface LicensingSubscriptionSubscriptionsClaimItemCounts {
/**
* Number of networks bound to this subscription
*/
networks?: pulumi.Input<number>;
/**
* Seat distribution
*/
seats?: pulumi.Input<inputs.administered.LicensingSubscriptionSubscriptionsClaimItemCountsSeats>;
}
interface LicensingSubscriptionSubscriptionsClaimItemCountsSeats {
/**
* Number of seats in use
*/
assigned?: pulumi.Input<number>;
/**
* Number of seats available for use
*/
available?: pulumi.Input<number>;
/**
* Total number of seats provided by this subscription
*/
limit?: pulumi.Input<number>;
}
interface LicensingSubscriptionSubscriptionsClaimItemEntitlement {
/**
* Seat distribution
*/
seats?: pulumi.Input<inputs.administered.LicensingSubscriptionSubscriptionsClaimItemEntitlementSeats>;
/**
* SKU of the required product
*/
sku?: pulumi.Input<string>;
}
interface LicensingSubscriptionSubscriptionsClaimItemEntitlementSeats {
/**
* Number of seats in use
*/
assigned?: pulumi.Input<number>;
/**
* Number of seats available for use
*/
available?: pulumi.Input<number>;
/**
* Total number of seats provided by this subscription for this sku
*/
limit?: pulumi.Input<number>;
}
interface LicensingSubscriptionSubscriptionsClaimKeyValidateItem {
/**
* Numeric breakdown of network and entitlement counts
*/
counts?: pulumi.Input<inputs.administered.LicensingSubscriptionSubscriptionsClaimKeyValidateItemCounts>;
/**
* Subscription description
*/
description?: pulumi.Input<string>;
/**
* Subscription expiration date
*/
endDate?: pulumi.Input<string>;
/**
* Entitlement info
*/
entitlements?: pulumi.Input<pulumi.Input<inputs.administered.LicensingSubscriptionSubscriptionsClaimKeyValidateItemEntitlement>[]>;
/**
* Subscription name
*/
name?: pulumi.Input<string>;
/**
* Products the subscription has entitlements for
*/
productTypes?: pulumi.Input<pulumi.Input<string>[]>;
/**
* Subscription start date
*/
startDate?: pulumi.Input<string>;
/**
* Subscription status
*/
status?: pulumi.Input<string>;
/**
* Subscription's ID
*/
subscriptionId?: pulumi.Input<string>;
/**
* Web order id
*/
webOrderId?: pulumi.Input<string>;
}
interface LicensingSubscriptionSubscriptionsClaimKeyValidateItemCounts {
/**
* Number of networks bound to this subscription
*/
networks?: pulumi.Input<number>;
/**
* Seat distribution
*/
seats?: pulumi.Input<inputs.administered.LicensingSubscriptionSubscriptionsClaimKeyValidateItemCountsSeats>;
}
interface LicensingSubscriptionSubscriptionsClaimKeyValidateItemCountsSeats {
/**
* Number of seats in use
*/
assigned?: pulumi.Input<number>;
/**
* Number of seats available for use
*/
available?: pulumi.Input<number>;
/**
* Total number of seats provided by this subscription
*/
limit?: pulumi.Input<number>;
}
interface LicensingSubscriptionSubscriptionsClaimKeyValidateItemEntitlement {
/**
* Seat distribution
*/
seats?: pulumi.Input<inputs.administered.LicensingSubscriptionSubscriptionsClaimKeyValidateItemEntitlementSeats>;
/**
* SKU of the required product
*/
sku?: pulumi.Input<string>;
}
interface LicensingSubscriptionSubscriptionsClaimKeyValidateItemEntitlementSeats {
/**
* Number of seats in use
*/
assigned?: pulumi.Input<number>;
/**
* Number of seats available for use
*/
available?: pulumi.Input<number>;
/**
* Total number of seats provided by this subscription for this sku
*/
limit?: pulumi.Input<number>;
}
interface LicensingSubscriptionSubscriptionsClaimKeyValidateParameters {
/**
* The subscription's claim key
*/
claimKey?: pulumi.Input<string>;
}
interface LicensingSubscriptionSubscriptionsClaimParameters {
/**
* The subscription's claim key
*/
claimKey?: pulumi.Input<string>;
/**
* Extra details or notes about the subscription
*/
description?: pulumi.Input<string>;
/**
* Friendly name to identify the subscription
*/
name?: pulumi.Input<string>;
/**
* The id of the organization claiming the subscription
*/
organizationId?: pulumi.Input<string>;
}
}
export declare namespace devices {
interface ApplianceRadioSettingsFiveGhzSettings {
/**
* Manual channel for 5 GHz
*/
channel?: pulumi.Input<number>;
/**
* Manual channel width for 5 GHz
*/
channelWidth?: pulumi.Input<number>;
/**
* Manual target power for 5 GHz
*/
targetPower?: pulumi.Input<number>;
}
interface ApplianceRadioSettingsTwoFourGhzSettings {
/**
* Manual channel for 2.4 GHz
*/
channel?: pulumi.Input<number>;
/**
* Manual target power for 2.4 GHz
*/
targetPower?: pulumi.Input<number>;
}
interface ApplianceUplinksSettingsInterfaces {
/**
* WAN 1 settings.
*/
wan1?: pulumi.Input<inputs.devices.ApplianceUplinksSettingsInterfacesWan1>;
/**
* WAN 2 settings.
*/
wan2?: pulumi.Input<inputs.devices.ApplianceUplinksSettingsInterfacesWan2>;
}
interface ApplianceUplinksSettingsInterfacesWan1 {
/**
* Enable or disable the interface.
*/
enabled?: pulumi.Input<boolean>;
/**
* Configuration options for PPPoE.
*/
pppoe?: pulumi.Input<inputs.devices.ApplianceUplinksSettingsInterfacesWan1Pppoe>;
/**
* SVI settings by protocol.
*/
svis?: pulumi.Input<inputs.devices.ApplianceUplinksSettingsInterfacesWan1Svis>;
/**
* VLAN tagging settings.
*/
vlanTagging?: pulumi.Input<inputs.devices.ApplianceUplinksSettingsInterfacesWan1VlanTagging>;
}
interface ApplianceUplinksSettingsInterfacesWan1Pppoe {
/**
* Settings for PPPoE Authentication.
*/
authentication?: pulumi.Input<inputs.devices.ApplianceUplinksSettingsInterfacesWan1PppoeAuthentication>;
/**
* Whether PPPoE is enabled.
*/
enabled?: pulumi.Input<boolean>;
}
interface ApplianceUplinksSettingsInterfacesWan1PppoeAuthentication {
/**
* Whether PPPoE authentication is enabled.
*/
enabled?: pulumi.Input<boolean>;
/**
* Password for PPPoE authentication. This parameter is not returned.
*/
password?: pulumi.Input<string>;
/**
* Username for PPPoE authentication.
*/
username?: pulumi.Input<string>;
}
interface ApplianceUplinksSettingsInterfacesWan1Svis {
/**
* IPv4 settings for static/dynamic mode.
*/
ipv4?: pulumi.Input<inputs.devices.ApplianceUplinksSettingsInterfacesWan1SvisIpv4>;
/**
* IPv6 settings for static/dynamic mode.
*/
ipv6?: pulumi.Input<inputs.devices.ApplianceUplinksSettingsInterfacesWan1SvisIpv6>;
}
interface ApplianceUplinksSettingsInterfacesWan1SvisIpv4 {
/**
* IP address and subnet mask when in static mode.
*/
address?: pulumi.Input<string>;
/**
* The assignment mode for this SVI. Applies only when PPPoE is disabled.
*/
assignmentMode?: pulumi.Input<string>;
/**
* Gateway IP address when in static mode.
*/
gateway?: pulumi.Input<string>;
/**
* The nameserver settings for this SVI.
*/
nameservers?: pulumi.Input<inputs.devices.ApplianceUplinksSettingsInterfacesWan1SvisIpv4Nameservers>;
}
interface ApplianceUplinksSettingsInterfacesWan1SvisIpv4Nameservers {
/**
* Up to 2 nameserver addresses to use, ordered in priority from highest to lowest priority.
*/
addresses?: pulumi.Input<pulumi.Input<string>[]>;
}
interface ApplianceUplinksSettingsInterfacesWan1SvisIpv6 {
/**
* Static address that will override the one(s) received by SLAAC.
*/
address?: pulumi.Input<string>;
/**
* The assignment mode for this SVI. Applies only when PPPoE is disabled.
*/
assignmentMode?: pulumi.Input<string>;
/**
* Static gateway that will override the one received by autoconf.
*/
gateway?: pulumi.Input<string>;
/**
* The nameserver settings for this SVI.
*/
nameservers?: pulumi.Input<inputs.devices.ApplianceUplinksSettingsInterfacesWan1SvisIpv6Nameservers>;
}
interface ApplianceUplinksSettingsInterfacesWan1SvisIpv6Nameservers {
/**
* Up to 2 nameserver addresses to use, ordered in priority from highest to lowest priority.
*/
addresses?: pulumi.Input<pulumi.Input<string>[]>;
}
interface ApplianceUplinksSettingsInterfacesWan1VlanTagging {
/**
* Whether VLAN tagging is enabled.
*/
enabled?: pulumi.Input<boolean>;
/**
* The ID of the VLAN to use for VLAN tagging.
*/
vlanId?: pulumi.Input<number>;
}
interface ApplianceUplinksSettingsInterfacesWan2 {
/**
* Enable or disable the interface.
*/
enabled?: pulumi.Input<boolean>;
/**
* Configuration options for PPPoE.
*/
pppoe?: pulumi.Input<inputs.devices.ApplianceUplinksSettingsInterfacesWan2Pppoe>;
/**
* SVI settings by protocol.
*/
svis?: pulumi.Input<inputs.devices.ApplianceUplinksSettingsInterfacesWan2Svis>;
/**
* VLAN tagging settings.
*/
vlanTagging?: pulumi.Input<inputs.devices.ApplianceUplinksSettingsInterfacesWan2VlanTagging>;
}
interface ApplianceUplinksSettingsInterfacesWan2Pppoe {
/**
* Settings for PPPoE Authentication.
*/
authentication?: pulumi.Input<inputs.devices.ApplianceUplinksSettingsInterfacesWan2PppoeAuthentication>;
/**
* Whether PPPoE is enabled.
*/
enabled?: pulumi.Input<boolean>;
}
interface ApplianceUplinksSettingsInterfacesWan2PppoeAuthentication {
/**
* Whether PPPoE authentication is enabled.
*/
enabled?: pulumi.Input<boolean>;
/**
* Password for PPPoE authentication. This parameter is not returned.
*/
password?: pulumi.Input<string>;
/**
* Username for PPPoE authentication.
*/
username?: pulumi.Input<string>;
}
interface ApplianceUplinksSettingsInterfacesWan2Svis {
/**
* IPv4 settings for static/dynamic mode.
*/
ipv4?: pulumi.Input<inputs.devices.ApplianceUplinksSettingsInterfacesWan2SvisIpv4>;
/**
* IPv6 settings for static/dynamic mode.
*/
ipv6?: pulumi.Input<inputs.devices.ApplianceUplinksSettingsInterfacesWan2SvisIpv6>;
}
interface ApplianceUplinksSettingsInterfacesWan2SvisIpv4 {
/**
* IP address and subnet mask when in static mode.
*/
address?: pulumi.Input<string>;
/**
* The assignment mode for this SVI. Applies only when PPPoE is disabled.
*/
assignmentMode?: pulumi.Input<string>;
/**
* Gateway IP address when in static mode.
*/
gateway?: pulumi.Input<string>;
/**
* The nameserver settings for this SVI.
*/
nameservers?: pulumi.Input<inputs.devices.ApplianceUplinksSettingsInterfacesWan2SvisIpv4Nameservers>;
}
interface ApplianceUplinksSettingsInterfacesWan2SvisIpv4Nameservers {
/**
* Up to 2 nameserver addresses to use, ordered in priority from highest to lowest priority.
*/
addresses?: pulumi.Input<pulumi.Input<string>[]>;
}
interface ApplianceUplinksSettingsInterfacesWan2SvisIpv6 {
/**
* Static address that will override the one(s) received by SLAAC.
*/
address?: pulumi.Input<string>;
/**
* The assignment mode for this SVI. Applies only when PPPoE is disabled.
*/
assignmentMode?: pulumi.Input<string>;
/**
* Static gateway that will override the one received by autoconf.
*/
gateway?: pulumi.Input<string>;
/**
* The nameserver settings for this SVI.
*/
nameservers?: pulumi.Input<inputs.devices.ApplianceUplinksSettingsInterfacesWan2SvisIpv6Nameservers>;
}
interface ApplianceUplinksSettingsInterfacesWan2SvisIpv6Nameservers {
/**
* Up to 2 nameserver addresses to use, ordered in priority from highest to lowest priority.
*/
addresses?: pulumi.Input<pulumi.Input<string>[]>;
}
interface ApplianceUplinksSettingsInterfacesWan2VlanTagging {
/**
* Whether VLAN tagging is enabled.
*/
enabled?: pulumi.Input<boolean>;
/**
* The ID of the VLAN to use for VLAN tagging.
*/
vlanId?: pulumi.Input<number>;
}
interface ApplianceVmxAuthenticationTokenItem {
/**
* The expiration time for the token, in ISO 8601 format
*/
expiresAt?: pulumi.Input<string>;
/**
* The newly generated authentication token for the vMX instance
*/
token?: pulumi.Input<string>;
}
interface BaseDetail {
/**
* Additional property name
*/
name?: pulumi.Input<string>;
/**
* Additional property value
*/
value?: pulumi.Input<string>;
}
interface BlinkLedsItem {
/**
* The duration in seconds. Will be between 5 and 120. Default is 20 seconds
*/
duration?: pulumi.Input<number>;
/**
* The duty cycle as the percent active. Will be between 10 and 90. Default is 50
*/
duty?: pulumi.Input<number>;
/**
* The period in milliseconds. Will be between 100 and 1000. Default is 160 milliseconds
*/
period?: pulumi.Input<number>;
}
interface BlinkLedsParameters {
/**
* The duration in seconds. Must be between 5 and 120. Default is 20 seconds
*/
duration?: pulumi.Input<number>;
/**
* The duty cycle as the percent active. Must be between 10 and 90. Default is 50.
*/
duty?: pulumi.Input<number>;
/**
* The period in milliseconds. Must be between 100 and 1000. Default is 160 milliseconds
*/
period?: pulumi.Input<number>;
}
interface CameraCustomAnalyticsParameter {
/**
* Name of the parameter
*/
name?: pulumi.Input<string>;
/**
* Value of the parameter
*/
value?: pulumi.Input<number>;
}
interface CameraGenerateSnapshotParameters {
/**
* [optional] If set to "true" the snapshot will be taken at full sensor resolution. This will error if used with timestamp.
*/
fullframe?: pulumi.Input<boolean>;
/**
* [optional] The snapshot will be taken from this time on the camera. The timestamp is expected to be in ISO 8601 format. If no timestamp is specified, we will assume current time.
*/
timestamp?: pulumi.Input<string>;
}
interface CameraSenseAudioDetection {
/**
* Boolean indicating if audio detection is enabled(true) or disabled(false) on the camera
*/
enabled?: pulumi.Input<boolean>;
}
interface CameraWirelessProfilesIds {
/**
* The id of the backup wireless profile
*/
backup?: pulumi.Input<string>;
/**
* The id of the primary wireless profile
*/
primary?: pulumi.Input<string>;
/**
* The id of the secondary wireless profile
*/
secondary?: pulumi.Input<string>;
}
interface CellularGatewayLanFixedIpAssignment {
/**
* The IP address you want to assign to a specific server or device
*/
ip?: pulumi.Input<string>;
/**
* The MAC address of the server or device that hosts the internal resource that you wish to receive the specified IP address
*/
mac?: pulumi.Input<string>;
/**
* A descriptive name of the assignment
*/
name?: pulumi.Input<string>;
}
interface CellularGatewayLanReservedIpRange {
/**
* Comment explaining the reserved IP range
*/
comment?: pulumi.Input<string>;
/**
* Ending IP included in the reserved range of IPs
*/
end?: pulumi.Input<string>;
/**
* Starting IP included in the reserved range of IPs
*/
start?: pulumi.Input<string>;
}
interface CellularGatewayPortForwardingRulesRule {
/**
* *any* or *restricted*. Specify the right to make inbound connections on the specified ports or port ranges. If *restricted*, a list of allowed IPs is mandatory.
*/
access?: pulumi.Input<string>;
/**
* An array of ranges of WAN IP addresses that are allowed to make inbound connections on the specified ports or port ranges.
*/
allowedIps?: pulumi.Input<pulumi.Input<string>[]>;
/**
* The IP address of the server or device that hosts the internal resource that you wish to make available on the WAN
*/
lanIp?: pulumi.Input<string>;
/**
* A port or port ranges that will receive the forwarded traffic from the WAN
*/
localPort?: pulumi.Input<string>;
/**
* A descriptive name for the rule
*/
name?: pulumi.Input<string>;
/**
* TCP or UDP
*/
protocol?: pulumi.Input<string>;
/**
* A port or port ranges that will be forwarded to the host on the LAN
*/
publicPort?: pulumi.Input<string>;
uplink?: pulumi.Input<string>;
}
interface CellularSimsSim {
/**
* APN configurations. If empty, the default APN will be used.
*/
apns?: pulumi.Input<pulumi.Input<inputs.devices.CellularSimsSimApn>[]>;
/**
* If true, this SIM is used for boot. Must be true on single-sim devices.
*/
isPrimary?: pulumi.Input<boolean>;
/**
* SIM slot being configured. Must be 'sim1' on single-sim devices.
*/
slot?: pulumi.Input<string>;
}
interface CellularSimsSimApn {
/**
* IP versions to support (permitted values include 'ipv4', 'ipv6').
*/
allowedIpTypes?: pulumi.Input<pulumi.Input<string>[]>;
/**
* APN authentication configurations.
*/
authentication?: pulumi.Input<inputs.devices.CellularSimsSimApnAuthentication>;
/**
* APN name.
*/
name?: pulumi.Input<string>;
}
interface CellularSimsSimApnAuthentication {
/**
* APN password, if type is set (if APN password is not supplied, the password is left unchanged).
*/
password?: pulumi.Input<string>;
/**
* APN auth type.
*/
type?: pulumi.Input<string>;
/**
* APN username, if type is set.
*/
username?: pulumi.Input<string>;
}
interface CellularSimsSimFailover {
/**
* Failover to secondary SIM (optional)
*/
enabled?: pulumi.Input<boolean>;
/**
* Failover timeout in seconds (optional)
*/
timeout?: pulumi.Input<number>;
}
interface LiveToolsArpTableCallback {
/**
* The webhook receiver used for the callback webhook.
*/
httpServer?: pulumi.Input<inputs.devices.LiveToolsArpTableCallbackHttpServer>;
/**
* The payload template of the webhook used for the callback
*/
payloadTemplate?: pulumi.Input<inputs.devices.LiveToolsArpTableCallbackPayloadTemplate>;
/**
* A shared secret that will be included in the requests sent to the callback URL. It can be used to verify that the request was sent by Meraki. If using this field, please also specify an url.
*/
sharedSecret?: pulumi.Input<string>;
/**
* The callback URL for the webhook target. If using this field, please also specify a sharedSecret.
*/
url?: pulumi.Input<string>;
}
interface LiveToolsArpTableCallbackHttpServer {
/**
* The webhook receiver ID that will receive information. If specifying this, please leave the url and sharedSecret fields blank.
*/
id?: pulumi.Input<string>;
}
interface LiveToolsArpTableCallbackPayloadTemplate {
/**
* The ID of the payload template. Defaults to 'wpt_00005' for the Callback (included) template.
*/
id?: pulumi.Input<string>;
}
interface LiveToolsArpTableEntry {
/**
* The IP address of the ARP table entry
*/
ip?: pulumi.Input<string>;
/**
* Time of the last update of the ARP table entry
*/
lastUpdatedAt?: pulumi.Input<string>;
/**
* The MAC address of the ARP table entry
*/
mac?: pulumi.Input<string>;
/**
* The VLAN ID of the ARP table entry
*/
vlanId?: pulumi.Input<number>;
}
interface LiveToolsArpTableRequest {
/**
* Device serial number
*/
serial?: pulumi.Input<string>;
}
interface LiveToolsCableCallback {
/**
* The webhook receiver used for the callback webhook.
*/
httpServer?: pulumi.Input<inputs.devices.LiveToolsCableCallbackHttpServer>;
/**
* The payload template of the webhook used for the callback
*/
payloadTemplate?: pulumi.Input<inputs.devices.LiveToolsCableCallbackPayloadTemplate>;
/**
* A shared secret that will be included in the requests sent to the callback URL. It can be used to verify that the request was sent by Meraki. If using this field, please also specify an url.
*/
sharedSecret?: pulumi.Input<string>;
/**
* The callback URL for the webhook target. If using this field, please also specify a sharedSecret.
*/
url?: pulumi.Input<string>;
}
interface LiveToolsCableCallbackHttpServer {
/**
* The webhook receiver ID that will receive information. If specifying this, please leave the url and sharedSecret fields blank.
*/
id?: pulumi.Input<string>;
}
interface LiveToolsCableCallbackPayloadTemplate {
/**
* The ID of the payload template. Defaults to 'wpt_00005' for the Callback (included) template.
*/
id?: pulumi.Input<string>;
}
interface LiveToolsCableRequest {
/**
* A list of ports for which to perform the cable test.
*/
ports?: pulumi.Input<pulumi.Input<string>[]>;
/**
* Device serial number
*/
serial?: pulumi.Input<string>;
}
interface LiveToolsCableResult {
/**
* If an error occurred during the cable test, the error message will be populated here.
*/
error?: pulumi.Input<string>;
/**
* Results for each twisted pair within the cable.
*/
pairs?: pulumi.Input<pulumi.Input<inputs.devices.LiveToolsCableResultPair>[]>;
/**
* The port for which the test was performed.
*/
port?: pulumi.Input<string>;
/**
* Speed in Mbps. A speed of 0 indicates the port is down or the port speed is automatic.
*/
speedMbps?: pulumi.Input<number>;
/**
* The current status of the port. If the cable test is still being performed on the port, "in-progress" is used. If an error occurred during the cable test, "error" is used and the error property will be populated.
*/
status?: pulumi.Input<string>;
}
interface LiveToolsCableResultPair {
/**
* The index of the twisted pair tested.
*/
index?: pulumi.Input<number>;
/**
* The detected length of the twisted pair.
*/
lengthMeters?: pulumi.Input<number>;
/**
* The test result of the twisted pair tested.
*/
status?: pulumi.Input<string>;
}
interface LiveToolsPingDeviceItem {
/**
* Information for callback used to send back results
*/
callback?: pulumi.Input<inputs.devices.LiveToolsPingDeviceItemCallback>;
/**
* Id to check the status of your ping request.
*/
pingId?: pulumi.Input<string>;
/**
* Ping request parameters
*/
request?: pulumi.Input<inputs.devices.LiveToolsPingDeviceItemRequest>;
/**
* Status of the ping request.
*/
status?: pulumi.Input<string>;
/**
* GET this url to check the status of your ping request.
*/
url?: pulumi.Input<string>;
}
interface LiveToolsPingDeviceItemCallback {
/**
* The ID of the callback. To check the status of the callback, use this ID in a request to /webhooks/callbacks/statuses/{id}
*/
id?: pulumi.Input<string>;
/**
* The status of the callback
*/
status?: pulumi.Input<string>;
/**
* The callback URL for the webhook target. This was either provided in the original request or comes from a configured webhook receiver
*/
url?: pulumi.Input<string>;
}
interface LiveToolsPingDeviceItemRequest {
/**
* Number of pings to send
*/
count?: pulumi.Input<number>;
/**
* Device serial number
*/
serial?: pulumi.Input<string>;
/**
* IP address or FQDN to ping
*/
target?: pulumi.Input<string>;
}
interface LiveToolsPingDeviceParameters {
/**
* Details for the callback. Please include either an httpServerId OR url and sharedSecret
*/
callback?: pulumi.Input<inputs.devices.LiveToolsPingDeviceParametersCallback>;
/**
* Count parameter to pass to ping. [1..5], default 5
*/
count?: pulumi.Input<number>;
}
interface LiveToolsPingDeviceParametersCallback {
/**
* The webhook receiver used for the callback webhook.
*/
httpServer?: pulumi.Input<inputs.devices.LiveToolsPingDeviceParametersCallbackHttpServer>;
/**
* The payload template of the webhook used for the callback
*/
payloadTemplate?: pulumi.Input<inputs.devices.LiveToolsPingDeviceParametersCallbackPayloadTemplate>;
/**
* A shared secret that will be included in the requests sent to the callback URL. It can be used to verify that the request was sent by Meraki. If using this field, please also specify an url.
*/
sharedSecret?: pulumi.Input<string>;
/**
* The callback URL for the webhook target. If using this field, please also specify a sharedSecret.
*/
url?: pulumi.Input<string>;
}
interface LiveToolsPingDeviceParametersCallbackHttpServer {
/**
* The webhook receiver ID that will receive information. If specifying this, please leave the url and sharedSecret fields blank.
*/
id?: pulumi.Input<string>;
}
interface LiveToolsPingDeviceParametersCallbackPayloadTemplate {
/**
* The ID of the payload template. Defaults to 'wpt_00005' for the Callback (included) template.
*/
id?: pulumi.Input<string>;
}
interface LiveToolsPingItem {
/**
* Information for callback used to send back results
*/
callback?: pulumi.Input<inputs.devices.LiveToolsPingItemCallback>;
/**
* Id to check the status of your ping request.
*/
pingId?: pulumi.Input<string>;
/**
* Ping request parameters
*/
request?: pulumi.Input<inputs.devices.LiveToolsPingItemRequest>;
/**
* Status of the ping request.
*/
status?: pulumi.Input<string>;
/**
* GET this url to check the status of your ping request.
*/
url?: pulumi.Input<string>;
}
interface LiveToolsPingItemCallback {
/**
* The ID of the callback. To check the status of the callback, use this ID in a request to /webhooks/callbacks/statuses/{id}
*/
id?: pulumi.Input<string>;
/**
* The status of the callback
*/
status?: pulumi.Input<string>;
/**
* The callback URL for the webhook target. This was either provided in the original request or comes from a configured webhook receiver
*/
url?: pulumi.Input<string>;
}
interface LiveToolsPingItemRequest {
/**
* Number of pings to send
*/
count?: pulumi.Input<number>;
/**
* Device serial number
*/
serial?: pulumi.Input<string>;
/**
* IP address or FQDN to ping
*/
target?: pulumi.Input<string>;
}
interface LiveToolsPingParameters {
/**
* Details for the callback. Please include either an httpServerId OR url and sharedSecret
*/
callback?: pulumi.Input<inputs.devices.LiveToolsPingParametersCallback>;
/**
* Count parameter to pass to ping. [1..5], default 5
*/
count?: pulumi.Input<number>;
/**
* FQDN, IPv4 or IPv6 address
*/
target?: pulumi.Input<string>;
}
interface LiveToolsPingParametersCallback {
/**
* The webhook receiver used for the callback webhook.
*/
httpServer?: pulumi.Input<inputs.devices.LiveToolsPingParametersCallbackHttpServer>;
/**
* The payload template of the webhook used for the callback
*/
payloadTemplate?: pulumi.Input<inputs.devices.LiveToolsPingParametersCallbackPayloadTemplate>;
/**
* A shared secret that will be included in the requests sent to the callback URL. It can be used to verify that the request was sent by Meraki. If using this field, please also specify an url.
*/
sharedSecret?: pulumi.Input<string>;
/**
* The callback URL for the webhook target. If using this field, please also specify a sharedSecret.
*/
url?: pulumi.Input<string>;
}
interface LiveToolsPingParametersCallbackHttpServer {
/**
* The webhook receiver ID that will receive information. If specifying this, please leave the url and sharedSecret fields blank.
*/
id?: pulumi.Input<string>;
}
interface LiveToolsPingParametersCallbackPayloadTemplate {
/**
* The ID of the payload template. Defaults to 'wpt_00005' for the Callback (included) template.
*/
id?: pulumi.Input<string>;
}
interface LiveToolsThroughputTestCallback {
/**
* The webhook receiver used for the callback webhook.
*/
httpServer?: pulumi.Input<inputs.devices.LiveToolsThroughputTestCallbackHttpServer>;
/**
* The payload template of the webhook used for the callback
*/
payloadTemplate?: pulumi.Input<inputs.devices.LiveToolsThroughputTestCallbackPayloadTemplate>;
/**
* A shared secret that will be included in the requests sent to the callback URL. It can be used to verify that the request was sent by Meraki. If using this field, please also specify an url.
*/
sharedSecret?: pulumi.Input<string>;
/**
* The callback URL for the webhook target. If using this field, please also specify a sharedSecret.
*/
url?: pulumi.Input<string>;
}
interface LiveToolsThroughputTestCallbackHttpServer {
/**
* The webhook receiver ID that will receive information. If specifying this, please leave the url and sharedSecret fields blank.
*/
id?: pulumi.Input<string>;
}
interface LiveToolsThroughputTestCallbackPayloadTemplate {
/**
* The ID of the payload template. Defaults to 'wpt_00005' for the Callback (included) template.
*/
id?: pulumi.Input<string>;
}
interface LiveToolsThroughputTestRequest {
/**
* Device serial number
*/
serial?: pulumi.Input<string>;
}
interface LiveToolsThroughputTestResult {
/**
* Shows the speeds (Mbps)
*/
speeds?: pulumi.Input<inputs.devices.LiveToolsThroughputTestResultSpeeds>;
}
interface LiveToolsThroughputTestResultSpeeds {
/**
* Shows the download speed from shard (Mbps)
*/
downstream?: pulumi.Input<number>;
}
interface LiveToolsWakeOnLanCallback {
/**
* The webhook receiver used for the callback webhook.
*/
httpServer?: pulumi.Input<inputs.devices.LiveToolsWakeOnLanCallbackHttpServer>;
/**
* The payload template of the webhook used for the callback
*/
payloadTemplate?: pulumi.Input<inputs.devices.LiveToolsWakeOnLanCallbackPayloadTemplate>;
/**
* A shared secret that will be included in the requests sent to the callback URL. It can be used to verify that the request was sent by Meraki. If using this field, please also specify an url.
*/
sharedSecret?: pulumi.Input<string>;
/**
* The callback URL for the webhook target. If using this field, please also specify a sharedSecret.
*/
url?: pulumi.Input<string>;
}
interface LiveToolsWakeOnLanCallbackHttpServer {
/**
* The webhook receiver ID that will receive information. If specifying this, please leave the url and sharedSecret fields blank.
*/
id?: pulumi.Input<string>;
}
interface LiveToolsWakeOnLanCallbackPayloadTemplate {
/**
* The ID of the payload template. Defaults to 'wpt_00005' for the Callback (included) template.
*/
id?: pulumi.Input<string>;
}
interface LiveToolsWakeOnLanRequest {
/**
* The target's MAC address
*/
mac?: pulumi.Input<string>;
/**
* Device serial number
*/
serial?: pulumi.Input<string>;
/**
* The target's VLAN (1 to 4094)
*/
vlanId?: pulumi.Input<number>;
}
interface ManagementInterfaceDdnsHostnames {
/**
* Active dynamic DNS hostname.
*/
activeDdnsHostname?: pulumi.Input<string>;
/**
* WAN 1 dynamic DNS hostname.
*/
ddnsHostnameWan1?: pulumi.Input<string>;
/**
* WAN 2 dynamic DNS hostname.
*/
ddnsHostnameWan2?: pulumi.Input<string>;
}
interface ManagementInterfaceWan1 {
/**
* Up to two DNS IPs.
*/
staticDns?: pulumi.Input<pulumi.Input<string>[]>;
/**
* The IP of the gateway on the WAN.
*/
staticGatewayIp?: pulumi.Input<string>;
/**
* The IP the device should use on the WAN.
*/
staticIp?: pulumi.Input<string>;
/**
* The subnet mask for the WAN.
*/
staticSubnetMask?: pulumi.Input<string>;
/**
* Configure the interface to have static IP settings or use DHCP.
*/
usingStaticIp?: pulumi.Input<boolean>;
/**
* The VLAN that management traffic should be tagged with. Applies whether usingStaticIp is true or false.
*/
vlan?: pulumi.Input<number>;
/**
* Enable or disable the interface (only for MX devices). Valid values are 'enabled', 'disabled', and 'not configured'.
*/
wanEnabled?: pulumi.Input<string>;
}
interface ManagementInterfaceWan2 {
/**
* Up to two DNS IPs.
*/
staticDns?: pulumi.Input<pulumi.Input<string>[]>;
/**
* The IP of the gateway on the WAN.
*/
staticGatewayIp?: pulumi.Input<string>;
/**
* The IP the device should use on the WAN.
*/
staticIp?: pulumi.Input<string>;
/**
* The subnet mask for the WAN.
*/
staticSubnetMask?: pulumi.Input<string>;
/**
* Configure the interface to have static IP settings or use DHCP.
*/
usingStaticIp?: pulumi.Input<boolean>;
/**
* The VLAN that management traffic should be tagged with. Applies whether usingStaticIp is true or false.
*/
vlan?: pulumi.Input<number>;
/**
* Enable or disable the interface (only for MX devices). Valid values are 'enabled', 'disabled', and 'not configured'.
*/
wanEnabled?: pulumi.Input<string>;
}
interface SensorRelationshipsLivestream {
/**
* An array of the related devices for the role
*/
relatedDevices?: pulumi.Input<pulumi.Input<inputs.devices.SensorRelationshipsLivestreamRelatedDevice>[]>;
}
interface SensorRelationshipsLivestreamRelatedDevice {
/**
* The product type of the related device
*/
productType?: pulumi.Input<string>;
/**
* The serial of the related device
*/
serial?: pulumi.Input<string>;
}
interface SensorRelationshipsLivestreamRequest {
/**
* An array of the related devices for the role
*/
relatedDevices?: pulumi.Input<pulumi.Input<inputs.devices.SensorRelationshipsLivestreamRequestRelatedDevice>[]>;
}
interface SensorRelationshipsLivestreamRequestRelatedDevice {
/**
* The product type of the related device
*/
productType?: pulumi.Input<string>;
/**
* The serial of the related device
*/
serial?: pulumi.Input<string>;
}
interface SwitchPortsCycleItem {
/**
* List of switch ports
*/
ports?: pulumi.Input<pulumi.Input<string>[]>;
}
interface SwitchPortsCycleParameters {
/**
* List of switch ports
*/
ports?: pulumi.Input<pulumi.Input<string>[]>;
}
interface SwitchPortsMirror {
/**
* The port mirror mode. Can be one of ('Destination port', 'Source port' or 'Not mirroring traffic').
*/
mode?: pulumi.Input<string>;
}
interface SwitchPortsModule {
/**
* The model of the expansion module.
*/
model?: pulumi.Input<string>;
}
interface SwitchPortsProfile {
/**
* When enabled, override this port's configuration with a port profile.
*/
enabled?: pulumi.Input<boolean>;
/**
* When enabled, the ID of the port profile used to override the port's configuration.
*/
id?: pulumi.Input<string>;
/**
* When enabled, the IName of the profile.
*/
iname?: pulumi.Input<string>;
}
interface SwitchRoutingInterfacesDhcpDhcpOption {
/**
* The code for DHCP option which should be from 2 to 254
*/
code?: pulumi.Input<string>;
/**
* The type of the DHCP option which should be one of ('text', 'ip', 'integer' or 'hex')
*/
type?: pulumi.Input<string>;
/**
* The value of the DHCP option
*/
value?: pulumi.Input<string>;
}
interface SwitchRoutingInterfacesDhcpFixedIpAssignment {
/**
* The IP address of the client which has fixed IP address assigned to it
*/
ip?: pulumi.Input<string>;
/**
* The MAC address of the client which has fixed IP address
*/
mac?: pulumi.Input<string>;
/**
* The name of the client which has fixed IP address
*/
name?: pulumi.Input<string>;
}
interface SwitchRoutingInterfacesDhcpReservedIpRange {
/**
* The comment for the reserved IP range
*/
comment?: pulumi.Input<string>;
/**
* The ending IP address of the reserved IP range
*/
end?: pulumi.Input<string>;
/**
* The starting IP address of the reserved IP range
*/
start?: pulumi.Input<string>;
}
interface SwitchRoutingInterfacesIpv6 {
/**
* IPv6 address
*/
address?: pulumi.Input<string>;
/**
* Assignment mode
*/
assignmentMode?: pulumi.Input<string>;
/**
* IPv6 gateway
*/
gateway?: pulumi.Input<string>;
/**
* IPv6 subnet
*/
prefix?: pulumi.Input<string>;
}
interface SwitchRoutingInterfacesOspfSettings {
/**
* Area id
*/
area?: pulumi.Input<string>;
/**
* OSPF Cost
*/
cost?: pulumi.Input<number>;
/**
* Disable sending Hello packets on this interface's IPv4 area
*/
isPassiveEnabled?: pulumi.Input<boolean>;
}
interface SwitchRoutingInterfacesOspfV3 {
/**
* Area id
*/
area?: pulumi.Input<string>;
/**
* OSPF Cost
*/
cost?: pulumi.Input<number>;
/**
* Disable sending Hello packets on this interface's IPv6 area
*/
isPassiveEnabled?: pulumi.Input<boolean>;
}
interface WirelessAlternateManagementInterfaceIpv6Item {
/**
* configured alternate management interface addresses
*/
addresses?: pulumi.Input<pulumi.Input<inputs.devices.WirelessAlternateManagementInterfaceIpv6ItemAddress>[]>;
}
interface WirelessAlternateManagementInterfaceIpv6ItemAddress {
/**
* The IP address configured for the alternate management interface
*/
address?: pulumi.Input<string>;
/**
* The type of address assignment. Either static or dynamic.
*/
assignmentMode?: pulumi.Input<string>;
/**
* The gateway address configured for the alternate managment interface
*/
gateway?: pulumi.Input<string>;
/**
* The DNS servers settings for this address.
*/
nameservers?: pulumi.Input<inputs.devices.WirelessAlternateManagementInterfaceIpv6ItemAddressNameservers>;
/**
* The IPv6 prefix of the interface. Required if IPv6 object is included.
*/
prefix?: pulumi.Input<string>;
/**
* The IP protocol used for the address
*/
protocol?: pulumi.Input<string>;
}
interface WirelessAlternateManagementInterfaceIpv6ItemAddressNameservers {
/**
* Up to 2 nameserver addresses to use, ordered in priority from highest to lowest priority.
*/
addresses?: pulumi.Input<pulumi.Input<string>[]>;
}
interface WirelessAlternateManagementInterfaceIpv6Parameters {
/**
* configured alternate management interface addresses
*/
addresses?: pulumi.Input<pulumi.Input<inputs.devices.WirelessAlternateManagementInterfaceIpv6ParametersAddress>[]>;
}
interface WirelessAlternateManagementInterfaceIpv6ParametersAddress {
/**
* The IP address configured for the alternate management interface
*/
address?: pulumi.Input<string>;
/**
* The type of address assignment. Either static or dynamic.
*/
assignmentMode?: pulumi.Input<string>;
/**
* The gateway address configured for the alternate managment interface
*/
gateway?: pulumi.Input<string>;
/**
* The DNS servers settings for this address.
*/
nameservers?: pulumi.Input<inputs.devices.WirelessAlternateManagementInterfaceIpv6ParametersAddressNameservers>;
/**
* The IPv6 prefix length of the IPv6 interface. Required if IPv6 object is included.
*/
prefix?: pulumi.Input<string>;
/**
* The IP protocol used for the address
*/
protocol?: pulumi.Input<string>;
}
interface WirelessAlternateManagementInterfaceIpv6ParametersAddressNameservers {
/**
* Up to 2 nameserver addresses to use, ordered in priority from highest to lowest priority.
*/
addresses?: pulumi.Input<pulumi.Input<string>[]>;
}
interface WirelessRadioSettingsFiveGhzSettings {
/**
* Sets a manual channel for 5 GHz. Can be '36', '40', '44', '48', '52', '56', '60', '64', '100', '104', '108', '112', '116', '120', '124', '128', '132', '136', '140', '144', '149', '153', '157', '161', '165', '169', '173' or '177' or null for using auto channel.
*/
channel?: pulumi.Input<number>;
/**
* Sets a manual channel for 5 GHz. Can be '0', '20', '40', '80' or '160' or null for using auto channel width.
*/
channelWidth?: pulumi.Input<string>;
/**
* Set a manual target power for 5 GHz. Can be between '8' or '30' or null for using auto power range.
*/
targetPower?: pulumi.Input<number>;
}
interface WirelessRadioSettingsTwoFourGhzSettings {
/**
* Sets a manual channel for 2.4 GHz. Can be '1', '2', '3', '4', '5',