Documentation
¶
Index ¶
- Constants
- func ClearMacs(rks *Ruckus)
- func IsCorrectMac(mac string) bool
- func IsDuplicatedMac(mac string, compareList []string) bool
- func WithDebug() func(*Ruckus)
- type Ap
- type Client
- type L2acl
- type LogonSessions
- type Options
- type Ruckus
- func (rks *Ruckus) AddMacsToL2acl(mac ...string) error
- func (rks *Ruckus) CheckBaseUrl() bool
- func (rks *Ruckus) CheckMacs(mac ...string) *Ruckus
- func (rks *Ruckus) CheckMacsWithNoDuplitation(mac ...string) *Ruckus
- func (rks *Ruckus) Close() error
- func (rks *Ruckus) CreateL2ACL(aclName string, restriction string, description string, macs ...string) *Ruckus
- func (rks *Ruckus) DeleteL2acl() error
- func (rks *Ruckus) DeleteL2aclByName(name string) error
- func (rks *Ruckus) DeleteMacsToL2acl(mac ...string) error
- func (rks *Ruckus) Err() error
- func (rks *Ruckus) GetAps() ([]Ap, error)
- func (rks *Ruckus) GetClients() ([]struct{ ... }, error)
- func (rks *Ruckus) GetClientsByApName(apName string) ([]Client, error)
- func (rks *Ruckus) GetCorrectMacs() []string
- func (rks *Ruckus) GetDuplicatedMacs() []string
- func (rks *Ruckus) GetErrorCode() int
- func (rks *Ruckus) GetErrorType() string
- func (rks *Ruckus) GetIncorrectMacs() []string
- func (rks *Ruckus) GetL2acl() (L2acl, error)
- func (rks *Ruckus) GetL2aclById(id string) (L2acl, error)
- func (rks *Ruckus) GetL2aclByName(name string) (L2acl, error)
- func (rks *Ruckus) GetL2aclId() string
- func (rks *Ruckus) GetL2aclList() ([]L2acl, error)
- func (rks *Ruckus) GetL2acls() ([]L2acl, error)
- func (rks *Ruckus) GetMessage() string
- func (rks *Ruckus) GetZoneId() string
- func (rks *Ruckus) GetZones() ([]Zone, error)
- func (rks *Ruckus) Logoff() error
- func (rks *Ruckus) Logon(username string, password string) error
- func (rks *Ruckus) SetBaseUrl(address string, port interface{}) *Ruckus
- func (rks *Ruckus) SetL2aclByName(name string) *Ruckus
- func (rks *Ruckus) SetZoneByName(name string) *Ruckus
- func (rks *Ruckus) Use(opts ...Options)
- type RuckusError
- type RuckusGeneral
- type Zone
Constants ¶
const ( L2ACL_Restriction_ALLOW = "ALLOW" L2ACL_Restriction_BLOCK = "BLOCK" )
Variables ¶
This section is empty.
Functions ¶
func IsCorrectMac ¶
func IsDuplicatedMac ¶
Types ¶
type Ap ¶
type Ap struct { // Administrative state of the AP. A locked AP will not provide any WLAN services. AdministrativeState string // Identifier of the AP group to which the AP belongs. If the AP belongs to the default AP group, this property is not needed. ApGroupId string // Venue code AwsVenue string // Description of the AP Description string // GPS Source of the AP GpsSource string // Latitude coordinate (in decimal format) of the AP Latitude float32 // Location of the AP. This is a free format text description that indicates the location of the AP Location string // Longitude coordinate (in decimal format) of the AP Longitude float32 // required // MAC address of the A Mac string // Model name of the AP // minLength: 2 // maxLength: 64 // pattern: "^[!-~]((?!\$\()[ -_a-~]){0,62}[!-~]$" Model string // Name of the AP Name string // Provision checklist of the AP. This field indicates the steps that have been completed in the AP provisioning process. ProvisionChecklist string // Serial number of the AP Serial string // required // Identifier of the zone to which the AP belongs ZoneId string }
Access Point
type Client ¶
type Client struct { // MAC of the Client Mac string // IP address of the Client IpAddress string // IP V6 address of the Client Ipv6Address string HostName string OsType string User string Status string // Radio inditifier RadioId string RadioMode string Channel string // WLAN inditifier WlanId string // SSID Ssid string // SNR(dB) Snr string // RSSI(dBm) Rssi string // RX Byte Rate RxByteRate int // TX Byte Rate TxByteRate int // RX Avg Byte Rate RxAvgByteRate int // TX Avg Byte Rate TxAvgByteRate int // From client bytes FromClientBytes int // To client bytes ToClientBytes int // From client package frames FromClientPkts int // To client package frames ToClientPkts int // Connected since (in milliseconds) ConnectedSince int // VLAN id Vlan string // AP Tx Data Rate ToClientDroppedPkts int }
Wireless Client
type L2acl ¶
type L2acl struct { // required // name of the L2 Access Control Name string `json:"name"` // identifier of the L2 Access Control Id string `json:"id"` // description of the L2 Access Control Description string `json:"description"` // identifier of the zone which the L2 Access Control belongs to ZoneId string `json:"zoneId"` // required // either ALLOW or BLOCK // restriction of the L2 Access Control, ALLOW: Only allow all stations listed below, BLOCK:Only block all stations listed below Restriction string `json:"restriction"` RuleMacs []string `json:"ruleMacs"` }
L2 Access Control
type LogonSessions ¶
type LogonSessions struct { Username string `json:"username"` Password string `json:"password"` TimeZoneUtcOffset string `json:"timeZoneUtcOffset"` }
func NewLogonSessions ¶
func NewLogonSessions(username string, password string) LogonSessions
type Ruckus ¶
type Ruckus struct { *RuckusError // contains filtered or unexported fields }
func (*Ruckus) AddMacsToL2acl ¶
L2 Access Control => Modify Rule Macs Modify a specific L2 Access Control Rule Macs. response code should be 204
func (*Ruckus) CheckBaseUrl ¶
func (*Ruckus) CheckMacsWithNoDuplitation ¶
func (*Ruckus) CreateL2ACL ¶
func (rks *Ruckus) CreateL2ACL(aclName string, restriction string, description string, macs ...string) *Ruckus
L2 Access Control => Create L2 Access Control Create a new L2 Access Control. response status code should be 201
func (*Ruckus) DeleteL2acl ¶
L2 Access Control => DELETE Delete an L2 Access Control. response code should be 204
func (*Ruckus) DeleteL2aclByName ¶
L2 Access Control => DELETE Delete an L2 Access Control. response code should be 204
func (*Ruckus) DeleteMacsToL2acl ¶
L2 Access Control => Modify Rule Macs Modify a specific L2 Access Control Rule Macs. response code should be 204
func (*Ruckus) GetAps ¶
Access Point Configuration => Retrieve List Use this API command to retrieve the list of APs that belong to a zone or a domain. response code should be 200
func (*Ruckus) GetClientsByApName ¶
Wireless Client => RETRIEVE CLIENT LIST Use this API command to retrieve the client list per AP. response code should be 200
func (*Ruckus) GetCorrectMacs ¶
func (*Ruckus) GetDuplicatedMacs ¶
func (*Ruckus) GetErrorCode ¶
func (*Ruckus) GetErrorType ¶
func (*Ruckus) GetIncorrectMacs ¶
func (*Ruckus) GetL2acl ¶
L2 Access Control => Retrieve Retrieve an L2 Access Control. response code should be 200
func (*Ruckus) GetL2aclById ¶
L2 Access Control => Retrieve Retrieve an L2 Access Control. response code should be 200
func (*Ruckus) GetL2aclByName ¶
L2 Access Control => Retrieve Retrieve an L2 Access Control. response code should be 200
func (*Ruckus) GetL2aclId ¶
func (*Ruckus) GetL2aclList ¶
L2 Access Control => Retrieve List Retrieve a list of L2 Access Control. response code should be 200
func (*Ruckus) GetMessage ¶
func (*Ruckus) GetZones ¶
Ruckus Wireless AP Zone => Retrieve List Use this API command to retrieve the list of Ruckus Wireless AP zones that belong to a domain. response code should be 200
func (*Ruckus) Logon ¶
Logon Sessions => Logon Use this API command to log on to the controller and acquire a valid logon session.