API ReferenceNew CentralGuidesMRT APIConfiguration API
GithubAirheads Developer Community
API Reference

Get hardware module profile

Configure and manage hardware module profiles.
A hardware module profile allows certain device-specific configuration to be applied
to a standalone switch, a chassis line-module or a VSF stack member. It is a mechanism
intended to ease the process of configuring these devices with the same set of
configurations. Instead of manually configuring each switch, line-module or VSF
member one-by-one, the hardware module profile collects the common configuration
settings and allows them to be applied to a specific device or a collection of
devices.
To apply a hardware module profile to a VSF member or group of VSF members, the
hw-profile name here must be referenced from their respective 'hw-profile' endpoints
in the 'switch-stack' API.
See aruba-switch-stack:stacks/stack/members/hw-profile.
Applicable to CX 6200, 6300, 6300L switches.
To apply a hardware module profile to a specific line-module or group of line-modules,
the profile name here must be referenced from their respective 'hw-profile' endpoint
in the switch-chassis' API.
See aruba-switch-chassis:switch-chassis/chassis/line-modules/hw-profile
Applicable to CX 6400, 8400X switches.
To apply a hardware module profile to a standalone switch, including devices that
support VSF but are not configured in a stack, no reference from another API is
required.

Recent Requests
Log in to see full request history
TimeStatusUser Agent
Retrieving recent requests…
LoadingLoading…
Query Params
string

LIBRARY - Returns shared objects in library. For LIBRARY, all other parameters listed below, except 'detailed' , will be ignored. LOCAL - Returns configurations for a scope and one or more device function based on parameters below.

string

Retrieves LOCAL or SHARED or both(default) configuration objects.

string

Configuration at a given scope. Mandatory for view-type = LOCAL.

string

Filters configuration specific to given device-function type. If not provided and view_type = LOCAL, then defaults to all device-function's.

boolean

True - Returns effective configuration (i.e hierarchically merged configuration). False - Returns committed configuration at a given scope.

boolean

True - Includes annotations in the returned json to indicate the type of object, scope, and device function. False - Returns only config objects without annotations.

integer

Limit for pagination.

integer

Offset for pagination.

Responses

Language
Credentials
OAuth2
URL
LoadingLoading…
Response
Click Try It! to start a request and see the response here! Or choose an example:
application/json