client

Documentation

Index

• Constants
• Variables
• type MerakiDashboard
  • func New(transport runtime.ClientTransport, formats strfmt.Registry) *MerakiDashboard
  • func NewHTTPClient(formats strfmt.Registry) *MerakiDashboard
  • func NewHTTPClientWithConfig(formats strfmt.Registry, cfg *TransportConfig) *MerakiDashboard
  • func (c *MerakiDashboard) SetTransport(transport runtime.ClientTransport)
• type TransportConfig
  • func DefaultTransportConfig() *TransportConfig
  • func (cfg *TransportConfig) WithBasePath(basePath string) *TransportConfig
  • func (cfg *TransportConfig) WithHost(host string) *TransportConfig
  • func (cfg *TransportConfig) WithSchemes(schemes []string) *TransportConfig

Constants

const (
	// DefaultHost is the default Host
	// found in Meta (info) section of spec file
	DefaultHost string = "api.meraki.com"
	// DefaultBasePath is the default BasePath
	// found in Meta (info) section of spec file
	DefaultBasePath string = "/api/v0"
)

Variables

var Default = NewHTTPClient(nil)

Default meraki dashboard HTTP client.

var DefaultSchemes = []string{"https"}

DefaultSchemes are the default schemes found in Meta (info) section of spec file

Types

type MerakiDashboard

type MerakiDashboard struct {
	ActionBatches action_batches.ClientService

	Admins admins.ClientService

	AlertSettings alert_settings.ClientService

	APIUsage api_usage.ClientService

	BluetoothClients bluetooth_clients.ClientService

	BluetoothSettings bluetooth_settings.ClientService

	CameraQualityRetentionProfiles camera_quality_retention_profiles.ClientService

	Cameras cameras.ClientService

	ChangeLog change_log.ClientService

	Clients clients.ClientService

	ConfigTemplates config_templates.ClientService

	ConnectivityMonitoringDestinations connectivity_monitoring_destinations.ClientService

	ContentFilteringCategories content_filtering_categories.ClientService

	ContentFilteringRules content_filtering_rules.ClientService

	DashboardBrandingPolicies dashboard_branding_policies.ClientService

	Devices devices.ClientService

	Events events.ClientService

	FirewalledServices firewalled_services.ClientService

	Floorplans floorplans.ClientService

	GroupPolicies group_policies.ClientService

	HTTPServers http_servers.ClientService

	IntrusionSettings intrusion_settings.ClientService

	Licenses licenses.ClientService

	LinkAggregations link_aggregations.ClientService

	MgConnectivityMonitoringDestinations m_g_connectivity_monitoring_destinations.ClientService

	MgdhcpSettings m_g_d_h_c_p_settings.ClientService

	MglanSettings m_g_l_a_n_settings.ClientService

	MgPortForwardingRules m_g_port_forwarding_rules.ClientService

	MgSubnetPoolSettings m_g_subnet_pool_settings.ClientService

	MgUplinkSettings m_g_uplink_settings.ClientService

	MrL3Firewall m_r_l3_firewall.ClientService

	MvSense m_v_sense.ClientService

	Mx11natRules m_x_1_1_n_a_t_rules.ClientService

	Mx1ManynatRules m_x_1_many_n_a_t_rules.ClientService

	MxCellularFirewall m_x_cellular_firewall.ClientService

	MxInboundFirewall m_x_inbound_firewall.ClientService

	MxL3Firewall m_x_l3_firewall.ClientService

	MxL7ApplicationCategories m_x_l7_application_categories.ClientService

	MxL7Firewall m_x_l7_firewall.ClientService

	MxPortForwardingRules m_x_port_forwarding_rules.ClientService

	MxStaticRoutes m_x_static_routes.ClientService

	MxvlanPorts m_x_v_l_a_n_ports.ClientService

	MxvpnFirewall m_x_v_p_n_firewall.ClientService

	MxWarmSpareSettings m_x_warm_spare_settings.ClientService

	MalwareSettings malware_settings.ClientService

	ManagementInterfaceSettings management_interface_settings.ClientService

	MerakiAuthUsers meraki_auth_users.ClientService

	MonitoredMediaServers monitored_media_servers.ClientService

	NamedTagScope named_tag_scope.ClientService

	NetFlowSettings net_flow_settings.ClientService

	Networks networks.ClientService

	OpenAPISpec open_api_spec.ClientService

	Organizations organizations.ClientService

	Pii p_i_i.ClientService

	RadioSettings radio_settings.ClientService

	SamlRoles s_a_m_l_roles.ClientService

	Sm s_m.ClientService

	SnmpSettings s_n_m_p_settings.ClientService

	SsiDs s_s_i_ds.ClientService

	SecurityEvents security_events.ClientService

	SplashLoginAttempts splash_login_attempts.ClientService

	SplashSettings splash_settings.ClientService

	SwitchacLs switch_a_c_ls.ClientService

	SwitchPortSchedules switch_port_schedules.ClientService

	SwitchPorts switch_ports.ClientService

	SwitchProfiles switch_profiles.ClientService

	SwitchSettings switch_settings.ClientService

	SwitchStacks switch_stacks.ClientService

	SyslogServers syslog_servers.ClientService

	TrafficAnalysisSettings traffic_analysis_settings.ClientService

	TrafficShaping traffic_shaping.ClientService

	UplinkSettings uplink_settings.ClientService

	VlaNs v_l_a_ns.ClientService

	WebhookLogs webhook_logs.ClientService

	WirelessHealth wireless_health.ClientService

	WirelessSettings wireless_settings.ClientService

	Transport runtime.ClientTransport
}

MerakiDashboard is a client for meraki dashboard

func New

func New(transport runtime.ClientTransport, formats strfmt.Registry) *MerakiDashboard

New creates a new meraki dashboard client

func NewHTTPClient

func NewHTTPClient(formats strfmt.Registry) *MerakiDashboard

NewHTTPClient creates a new meraki dashboard HTTP client.

func NewHTTPClientWithConfig

func NewHTTPClientWithConfig(formats strfmt.Registry, cfg *TransportConfig) *MerakiDashboard

NewHTTPClientWithConfig creates a new meraki dashboard HTTP client, using a customizable transport config.

func (*MerakiDashboard) SetTransport

func (c *MerakiDashboard) SetTransport(transport runtime.ClientTransport)

SetTransport changes the transport on the client and all its subresources

type TransportConfig

type TransportConfig struct {
	Host     string
	BasePath string
	Schemes  []string
}

TransportConfig contains the transport related info, found in the meta section of the spec file.

func DefaultTransportConfig

func DefaultTransportConfig() *TransportConfig

DefaultTransportConfig creates a TransportConfig with the default settings taken from the meta section of the spec file.

func (*TransportConfig) WithBasePath

func (cfg *TransportConfig) WithBasePath(basePath string) *TransportConfig

WithBasePath overrides the default basePath, provided by the meta section of the spec file.

func (*TransportConfig) WithHost

func (cfg *TransportConfig) WithHost(host string) *TransportConfig

WithHost overrides the default host, provided by the meta section of the spec file.

func (*TransportConfig) WithSchemes

func (cfg *TransportConfig) WithSchemes(schemes []string) *TransportConfig

WithSchemes overrides the default schemes, provided by the meta section of the spec file.