com.hp.ov.sdk.rest.client.networking

Interface LogicalInterconnectClient

All Superinterfaces:

RetrievableResource<LogicalInterconnect>, SearchableResource<LogicalInterconnect>

public interface LogicalInterconnectClient
extends SearchableResource<LogicalInterconnect>

Nested Class Summary

Nested classes/interfaces inherited from interface com.hp.ov.sdk.rest.client.common.SearchableResource

SearchableResource.GetByNameRequestInterceptor

Field Summary

Fields

Modifier and Type	Field and Description
static String	LOGICAL_INTERCONNECT_COMPLIANCE_URI
static String	LOGICAL_INTERCONNECT_CONFIGURATION_URI
static String	LOGICAL_INTERCONNECT_ETHERNET_SETTINGS_URI
static String	LOGICAL_INTERCONNECT_FIRMWARE_URI
static String	LOGICAL_INTERCONNECT_FORWARDING_INFORMATION_BASE_URI
static String	LOGICAL_INTERCONNECT_INTERCONNECTS_URI
static String	LOGICAL_INTERCONNECT_INTERNAL_NETWORKS_URI
static String	LOGICAL_INTERCONNECT_INTERNAL_VLANS_URI
static String	LOGICAL_INTERCONNECT_LOCATION_URI
static String	LOGICAL_INTERCONNECT_PORT_MONITOR_URI
static String	LOGICAL_INTERCONNECT_QOS_AGGREGATED_CONFIGURATION_URI
static String	LOGICAL_INTERCONNECT_SETTINGS_URI
static String	LOGICAL_INTERCONNECT_SNMP_CONFIGURATION_URI
static String	LOGICAL_INTERCONNECT_TELEMETRY_CONFIGURATION_URI
static String	LOGICAL_INTERCONNECT_UNASSIGNED_UPLINK_PORTS_URI
static String	LOGICAL_INTERCONNECT_URI

Method Summary

Modifier and Type	Method and Description
InterconnectFibDataInfo	createForwardingInformationBase(String resourceId) This module aids in generating the forwarding information base dump file for a logical interconnect.
TaskResource	createInterconnect(Location location, RequestOption... options) The module aids in creating an interconnect at the given location.
TaskResource	deleteInterconnect(String enclosureUri, String bay, RequestOption... options) The module aids in removing an interconnect from a location.
EthernetInterconnectSettingsV2	getEthernetSettings(String resourceId) This module aids in fetching the ethernet settings for a logical interconnect.
LiFirmware	getFirmware(String resourceId) The module aids in fetching the logical interconnect firmware for the specified logical interconnect identified by the resource identifier.
ResourceCollection<InterconnectFibDataEntry>	getForwardingInformationBase(String resourceId) This module aids in fetching the forwarding information base data for a logical interconnect.
ResourceCollection<InternalVlanAssociation>	getInternalVlans(String resourceId) This module aids in fetching the internal VLAN identifiers for the provisioned networks of a logical interconnect.
PortMonitor	getPortMonitorConfiguration(String resourceId) This module aids in fetching the port monitor configuration of a logical interconnect.
QosAggregatedConfiguration	getQosAggregatedConfiguration(String resourceId) This method aids in fetching the QoS aggregated configuration for the logical interconnect.
SnmpConfiguration	getSnmpConfiguration(String resourceId) This module aids in fetching the SNMP configuration for a logical interconnect that is specified by resource identifier.
TelemetryConfiguration	getTelemetryConfiguration(String resourceId, String telemetryConfigurationId) This module aids in fetching the telemetry configuration of a logical interconnect.
ResourceCollection<PortMonitorUplinkPort>	getUnassignedUplinkPortsForPortMonitor(String resourceId) This module aids in fetching a collection of uplink ports from the member interconnects, which are eligible for assignment to an analyzer port.
TaskResource	updateCompliance(String resourceId, RequestOption... options) This module aids in fetching a logical interconnect to a consistent state.
TaskResource	updateConfiguration(String resourceId, RequestOption... options) This module aids in asynchronously applying or re-applying the logical interconnect configuration to all managed interconnects.
TaskResource	updateEthernetSettings(String resourceId, EthernetInterconnectSettingsV2 ethernetSettings, RequestOption... options) This method aids in updating the ethernet interconnect settings for the logical interconnect.
TaskResource	updateFirmware(String resourceId, LiFirmware liFirmware, RequestOption... options) The method installs firmware to a logical interconnect.
TaskResource	updateInternalNetworks(String resourceId, List<String> networkUris, RequestOption... options) This module aids in updating the internal networks of a logical interconnect.
TaskResource	updatePortMonitorConfiguration(String resourceId, PortMonitor portMonitor, RequestOption... options) This module aids in updating the port monitor configuration of a logical interconnect.
TaskResource	updateQosAggregatedConfiguration(String resourceId, QosAggregatedConfiguration qosAggregatedConfiguration, RequestOption... options) This modules aids in updating the QoS aggregated configuration for the logical interconnect.
TaskResource	updateSettings(String resourceId, InterconnectSettingsV2 interconnectSettings, RequestOption... options) This modules aids in updating interconnect settings on the logical interconnect.
TaskResource	updateSnmpConfiguration(String resourceId, SnmpConfiguration snmpConfiguration, RequestOption... options) This modules aids in updating the SNMP configuration of a logical interconnect.
TaskResource	updateTelemetryConfiguration(String resourceId, String telemetryConfigurationId, TelemetryConfiguration telemetryConfiguration, RequestOption... options) This module aids in updating the telemetry configuration of a logical interconnect specified by resource identifier.
TelemetryConfiguration	updateTelemetryConfigurationV120(String resourceId, String telemetryConfigurationId, TelemetryConfiguration telemetryConfiguration) This module aids in updating the telemetry configuration of a logical interconnect specified by resource identifier.

Methods inherited from interface com.hp.ov.sdk.rest.client.common.SearchableResource

getByName

Methods inherited from interface com.hp.ov.sdk.rest.client.common.RetrievableResource

get, get, getAll, getAll, getById

Field Detail

LOGICAL_INTERCONNECT_URI

static final String LOGICAL_INTERCONNECT_URI

See Also:

Constant Field Values

LOGICAL_INTERCONNECT_FIRMWARE_URI

static final String LOGICAL_INTERCONNECT_FIRMWARE_URI

See Also:

Constant Field Values

LOGICAL_INTERCONNECT_LOCATION_URI

static final String LOGICAL_INTERCONNECT_LOCATION_URI

See Also:

Constant Field Values

LOGICAL_INTERCONNECT_INTERCONNECTS_URI

static final String LOGICAL_INTERCONNECT_INTERCONNECTS_URI

See Also:

Constant Field Values

LOGICAL_INTERCONNECT_SNMP_CONFIGURATION_URI

static final String LOGICAL_INTERCONNECT_SNMP_CONFIGURATION_URI

See Also:

Constant Field Values

LOGICAL_INTERCONNECT_FORWARDING_INFORMATION_BASE_URI

static final String LOGICAL_INTERCONNECT_FORWARDING_INFORMATION_BASE_URI

See Also:

Constant Field Values

LOGICAL_INTERCONNECT_CONFIGURATION_URI

static final String LOGICAL_INTERCONNECT_CONFIGURATION_URI

See Also:

Constant Field Values

LOGICAL_INTERCONNECT_QOS_AGGREGATED_CONFIGURATION_URI

static final String LOGICAL_INTERCONNECT_QOS_AGGREGATED_CONFIGURATION_URI

See Also:

Constant Field Values

LOGICAL_INTERCONNECT_TELEMETRY_CONFIGURATION_URI

static final String LOGICAL_INTERCONNECT_TELEMETRY_CONFIGURATION_URI

See Also:

Constant Field Values

LOGICAL_INTERCONNECT_PORT_MONITOR_URI

static final String LOGICAL_INTERCONNECT_PORT_MONITOR_URI

See Also:

Constant Field Values

LOGICAL_INTERCONNECT_SETTINGS_URI

static final String LOGICAL_INTERCONNECT_SETTINGS_URI

See Also:

Constant Field Values

LOGICAL_INTERCONNECT_ETHERNET_SETTINGS_URI

static final String LOGICAL_INTERCONNECT_ETHERNET_SETTINGS_URI

See Also:

Constant Field Values

LOGICAL_INTERCONNECT_COMPLIANCE_URI

static final String LOGICAL_INTERCONNECT_COMPLIANCE_URI

See Also:

Constant Field Values

LOGICAL_INTERCONNECT_INTERNAL_NETWORKS_URI

static final String LOGICAL_INTERCONNECT_INTERNAL_NETWORKS_URI

See Also:

Constant Field Values

LOGICAL_INTERCONNECT_INTERNAL_VLANS_URI

static final String LOGICAL_INTERCONNECT_INTERNAL_VLANS_URI

See Also:

Constant Field Values

LOGICAL_INTERCONNECT_UNASSIGNED_UPLINK_PORTS_URI

static final String LOGICAL_INTERCONNECT_UNASSIGNED_UPLINK_PORTS_URI

See Also:

Constant Field Values

Method Detail

createInterconnect

TaskResource createInterconnect(Location location,
                                RequestOption... options)

The module aids in creating an interconnect at the given location.

Parameters:

location - location for the logical interconnect as seen in HPE OneView.

options - varargs of RequestOption, which can be used to specify some request options.

Returns:

TaskResource containing the task status for the process.

deleteInterconnect

TaskResource deleteInterconnect(String enclosureUri,
                                String bay,
                                RequestOption... options)

The module aids in removing an interconnect from a location.

Parameters:

enclosureUri - enclosure URI as seen in HPE OneView.

bay - bay of the interconnect as seen in HPE OneView.

options - varargs of RequestOption, which can be used to specify some request options..

Returns:

TaskResource containing the task status for the process.

getSnmpConfiguration

SnmpConfiguration getSnmpConfiguration(String resourceId)

This module aids in fetching the SNMP configuration for a logical interconnect that is specified by resource identifier.

Parameters:

resourceId - resource identifier for logical interconnect as seen in HPE OneView.

Returns:

SnmpConfiguration containing the SNMP configuration details.

updateSnmpConfiguration

TaskResource updateSnmpConfiguration(String resourceId,
                                     SnmpConfiguration snmpConfiguration,
                                     RequestOption... options)

This modules aids in updating the SNMP configuration of a logical interconnect. Changes to the SNMP configuration are asynchronously applied to all managed interconnects.

Parameters:

resourceId - resource identifier for logical interconnect as seen in HPE OneView.

snmpConfiguration - object containing the update to be made to the logical interconnect.

options - varargs of RequestOption, which can be used to specify some request options.

Returns:

TaskResource containing the task status for the process.

getForwardingInformationBase

ResourceCollection<InterconnectFibDataEntry> getForwardingInformationBase(String resourceId)

This module aids in fetching the forwarding information base data for a logical interconnect.

Parameters:

resourceId - resource identifier for logical interconnect as seen in HPE OneView.

Returns:

ResourceCollection<InterconnectFibDataEntry> containing the details for all found interconnect forwarding information base data.

createForwardingInformationBase

InterconnectFibDataInfo createForwardingInformationBase(String resourceId)

This module aids in generating the forwarding information base dump file for a logical interconnect.

Parameters:

resourceId - resource identifier for logical interconnect as seen in HPE OneView.

Returns:

InterconnectFibDataInfo containing the interconnect forwarding information base data details.

getFirmware

LiFirmware getFirmware(String resourceId)

The module aids in fetching the logical interconnect firmware for the specified logical interconnect identified by the resource identifier.

Parameters:

resourceId - resource identifier for logical interconnect as seen in HPE OneView.

Returns:

LiFirmware containing the logical interconnect LI firmware details.

updateFirmware

TaskResource updateFirmware(String resourceId,
                            LiFirmware liFirmware,
                            RequestOption... options)

The method installs firmware to a logical interconnect. The three operations that are supported for the firmware update are STAGE (uploads firmware to the interconnect), ACTIVATE (installs firmware on the interconnect) and UPDATE (which does a STAGE and ACTIVATE in a sequential manner).

Parameters:

resourceId - resource identifier for logical interconnect as seen in HPE OneView.

liFirmware - object containing the update to be made to the logical interconnect.

options - varargs of RequestOption, which can be used to specify some request options.

Returns:

TaskResource containing the task status for the process.

getQosAggregatedConfiguration

QosAggregatedConfiguration getQosAggregatedConfiguration(String resourceId)

This method aids in fetching the QoS aggregated configuration for the logical interconnect.

Parameters:

resourceId - resource identifier for logical interconnect as seen in HPE OneView.

Returns:

QosAggregatedConfiguration containing the QoS configuration details.

updateQosAggregatedConfiguration

TaskResource updateQosAggregatedConfiguration(String resourceId,
                                              QosAggregatedConfiguration qosAggregatedConfiguration,
                                              RequestOption... options)

This modules aids in updating the QoS aggregated configuration for the logical interconnect.

Parameters:

resourceId - resource identifier for logical interconnect as seen in HPE OneView.

qosAggregatedConfiguration - object containing the update to be made to the logical interconnect.

options - varargs of RequestOption, which can be used to specify some request options.

Returns:

TaskResource containing the task status for the process.

getTelemetryConfiguration

TelemetryConfiguration getTelemetryConfiguration(String resourceId,
                                                 String telemetryConfigurationId)

This module aids in fetching the telemetry configuration of a logical interconnect.

Parameters:

resourceId - resource identifier for logical interconnect as seen in HPE OneView.

telemetryConfigurationId - telemetry configuration identifier for the logical interconnect as seen in HPE OneView.

Returns:

TelemetryConfiguration containing the telemetry configuration details.

updateTelemetryConfigurationV120

TelemetryConfiguration updateTelemetryConfigurationV120(String resourceId,
                                                        String telemetryConfigurationId,
                                                        TelemetryConfiguration telemetryConfiguration)

This module aids in updating the telemetry configuration of a logical interconnect specified by resource identifier.

Parameters:

resourceId - resource identifier for logical interconnect as seen in HPE OneView.

telemetryConfigurationId - telemetry configuration identifier for the logical interconnect as seen in HPE OneView.

telemetryConfiguration - object containing the update to be made to existing telemetry configuration for logical interconnect.

Returns:

TelemetryConfiguration containing the telemetry configuration details.

updateTelemetryConfiguration

TaskResource updateTelemetryConfiguration(String resourceId,
                                          String telemetryConfigurationId,
                                          TelemetryConfiguration telemetryConfiguration,
                                          RequestOption... options)

This module aids in updating the telemetry configuration of a logical interconnect specified by resource identifier.

Parameters:

resourceId - resource identifier for logical interconnect as seen in HPE OneView.

telemetryConfigurationId - telemetry configuration identifier for the logical interconnect as seen in HPE OneView.

telemetryConfiguration - object containing the update to be made to existing telemetry configuration for logical interconnect.

options - varargs of RequestOption, which can be used to specify some request options.

Returns:

TaskResource containing the task status for the process.

Since:

HPE OneView 2.0

getPortMonitorConfiguration

PortMonitor getPortMonitorConfiguration(String resourceId)

This module aids in fetching the port monitor configuration of a logical interconnect.

Parameters:

resourceId - resource identifier for logical interconnect as seen in HPE OneView.

Returns:

PortMonitor containing the port monitor details.

updatePortMonitorConfiguration

TaskResource updatePortMonitorConfiguration(String resourceId,
                                            PortMonitor portMonitor,
                                            RequestOption... options)

This module aids in updating the port monitor configuration of a logical interconnect.

Parameters:

resourceId - resource identifier for logical interconnect as seen in HPE OneView.

portMonitor - port monitor fom the logical interconnect as seen in HPE OneView.

options - varargs of RequestOption, which can be used to specify some request options.

Returns:

TaskResource containing the task status for the process.

updateConfiguration

TaskResource updateConfiguration(String resourceId,
                                 RequestOption... options)

This module aids in asynchronously applying or re-applying the logical interconnect configuration to all managed interconnects.

Parameters:

resourceId - resource identifier for logical interconnect as seen in HPE OneView.

options - varargs of RequestOption, which can be used to specify some request options.

Returns:

TaskResource containing the task status for the process.

updateSettings

TaskResource updateSettings(String resourceId,
                            InterconnectSettingsV2 interconnectSettings,
                            RequestOption... options)

This modules aids in updating interconnect settings on the logical interconnect. Changes to interconnect settings are asynchronously applied to all managed interconnects.

Parameters:

resourceId - resource identifier for logical interconnect as seen in HPE OneView.

interconnectSettings - interconnect settings for logical interconnect as seen in HPE OneView.

options - varargs of RequestOption, which can be used to specify some request options.

Returns:

TaskResource containing the task status for the process.

getEthernetSettings

EthernetInterconnectSettingsV2 getEthernetSettings(String resourceId)

This module aids in fetching the ethernet settings for a logical interconnect.

Parameters:

resourceId - resource identifier for logical interconnect as seen in HPE OneView.

Returns:

EthernetInterconnectSettingsV2 containing the logical interconnect ethernet settings details.

updateEthernetSettings

TaskResource updateEthernetSettings(String resourceId,
                                    EthernetInterconnectSettingsV2 ethernetSettings,
                                    RequestOption... options)

This method aids in updating the ethernet interconnect settings for the logical interconnect.

Parameters:

resourceId - resource identifier for logical interconnect as seen in HPE OneView.

ethernetSettings - ethernet settings for logical interconnect as seen in HPE OneView.

options - varargs of RequestOption, which can be used to specify some request options.

Returns:

TaskResource containing the task status for the process.

updateCompliance

TaskResource updateCompliance(String resourceId,
                              RequestOption... options)

This module aids in fetching a logical interconnect to a consistent state. The current logical interconnect state is compared to the associated logical interconnect group. Any differences identified are corrected, bringing the logical interconnect back to a consistent state. Changes are asynchronously applied to all managed interconnects.

Parameters:

resourceId - resource identifier for logical interconnect as seen in HPE OneView.

options - varargs of RequestOption, which can be used to specify some request options.

Returns:

TaskResource containing the task status for the process.

updateInternalNetworks

TaskResource updateInternalNetworks(String resourceId,
                                    List<String> networkUris,
                                    RequestOption... options)

This module aids in updating the internal networks of a logical interconnect.

Parameters:

resourceId - resource identifier for logical interconnect as seen in HPE OneView.

networkUris - list containing the resource identifiers for logical interconnect as seen in HPE OneView.

options - varargs of RequestOption, which can be used to specify some request options.

Returns:

TaskResource containing the task status for the process.

getInternalVlans

ResourceCollection<InternalVlanAssociation> getInternalVlans(String resourceId)

This module aids in fetching the internal VLAN identifiers for the provisioned networks of a logical interconnect.

Parameters:

resourceId - resource identifier for logical interconnect as seen in HPE OneView.

Returns:

ResourceCollection<InternalVlanAssociation> containing the details for all found internal VLAN associations.

getUnassignedUplinkPortsForPortMonitor

ResourceCollection<PortMonitorUplinkPort> getUnassignedUplinkPortsForPortMonitor(String resourceId)

This module aids in fetching a collection of uplink ports from the member interconnects, which are eligible for assignment to an analyzer port.

Parameters:

resourceId - resource identifier for logical interconnect as seen in HPE OneView.

Returns:

ResourceCollection<PortMonitorUplinkPort> containing the details for all found uplink ports for port monitor.