com.emc.vipr.client.core

Class NetworkSystems

java.lang.Object

com.emc.vipr.client.core.AbstractResources<T>

com.emc.vipr.client.core.AbstractBulkResources<T>

com.emc.vipr.client.core.AbstractCoreBulkResources<NetworkSystemRestRep>

com.emc.vipr.client.core.NetworkSystems

All Implemented Interfaces:

BulkResources<NetworkSystemRestRep>, Resources<NetworkSystemRestRep>, TaskResources<NetworkSystemRestRep>, TopLevelResources<NetworkSystemRestRep>

public class NetworkSystems
extends AbstractCoreBulkResources<NetworkSystemRestRep>
implements TopLevelResources<NetworkSystemRestRep>, TaskResources<NetworkSystemRestRep>

Network Systems resources.

Base URL: /vdc/network-systems

Constructor Summary

Constructors

Constructor and Description
NetworkSystems(ViPRCoreClient parent, RestClient client)

Method Summary

Modifier and Type	Method and Description
Task<NetworkSystemRestRep>	activateSanZones(java.net.URI id, java.lang.String fabric, SanZones input) Activates the current active zoneset of the fabric.
Task<NetworkSystemRestRep>	addAliases(java.net.URI id, WwnAliasesCreateParam input) Adds WWN Aliases to the given network system by ID and fabric name.
Task<NetworkSystemRestRep>	addSanZones(java.net.URI id, java.lang.String fabric, SanZoneCreateParam input) Adds SAN zones to the given network system by ID and fabric name.
Task<NetworkSystemRestRep>	create(NetworkSystemCreate input) Begins creating a network system.
Task<NetworkSystemRestRep>	deactivate(java.net.URI id) Begins deactivating a network system by ID.
Task<NetworkSystemRestRep>	deleteAliases(java.net.URI id, WwnAliasesDeleteParam input) Removes WWN Aliases from the given network system by ID.
NetworkSystemRestRep	deregister(java.net.URI id) Deregisters the given network system by ID.
Task<NetworkSystemRestRep>	discover(java.net.URI id) Begins discovery of the given network system by ID.
java.util.List<? extends WwnAliasParam>	getAliases(java.net.URI id, java.lang.String fabric) Gets the list of WWN Aliases in the given network system by ID and fabric name.
java.util.List<NetworkSystemRestRep>	getAll() Gets the list of all network systems.
java.util.List<NetworkSystemRestRep>	getAll(ResourceFilter<NetworkSystemRestRep> filter) Gets the list of all network systems, optionally filtering the results.
java.util.List<FCEndpointRestRep>	getFCEndpoints(java.net.URI id, java.lang.String fabricId) Gets the list of FC endpoints in the given network system by ID.
java.util.List<java.lang.String>	getSanFabrics(java.net.URI id) Gets the list of SAN fabric names in the given network system by ID.
java.util.List<SanZone>	getSanZones(java.net.URI id, java.lang.String fabric) Gets the list of SAN zones in the given network system by ID and fabric name.
Task<NetworkSystemRestRep>	getTask(java.net.URI id, java.net.URI taskId) Gets a single task associated with a given resource by ID.
Tasks<NetworkSystemRestRep>	getTasks(java.net.URI id) Gets the tasks associated with a given resource by ID.
java.util.List<NamedRelatedResourceRep>	list() Lists all network systems.
NetworkSystemRestRep	register(java.net.URI id) Registers the given network system by ID.
Task<NetworkSystemRestRep>	removeSanZones(java.net.URI id, java.lang.String fabric, SanZonesDeleteParam input) Removes a SAN zone from the given network system by ID and fabric name.
Task<NetworkSystemRestRep>	update(java.net.URI id, NetworkSystemUpdate input) Begins updating a network system by ID.
Task<NetworkSystemRestRep>	updateAliases(java.net.URI id, WwnAliasUpdateParams input) Updates WWN Aliases from the given network system by ID.
Task<NetworkSystemRestRep>	updateSanZones(java.net.URI id, java.lang.String fabric, SanZoneUpdateParams input) Updates a SAN zone from the given network system by ID and fabric name.
NetworkSystems	withInactive(boolean inactive) Configures the fetch operations to include inactive resources.
NetworkSystems	withInternal(boolean internal) Configures the fetch operations to include internal resources.

Methods inherited from class com.emc.vipr.client.core.AbstractBulkResources

getByIds, getByRefs, listBulkIds

Methods inherited from class com.emc.vipr.client.core.AbstractResources

addTags, get, get, getByIds, getByRefs, getTags, performSearch, performSearchBy, removeTags, search, updateTags

Methods inherited from class java.lang.Object

equals, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Methods inherited from interface com.emc.vipr.client.core.BulkResources

getByIds, getByRefs

Methods inherited from interface com.emc.vipr.client.core.Resources

addTags, get, get, getTags, removeTags, search, updateTags

Constructor Detail

NetworkSystems

public NetworkSystems(ViPRCoreClient parent,
                      RestClient client)

Method Detail

withInactive

public NetworkSystems withInactive(boolean inactive)

Description copied from class: AbstractResources

Configures the fetch operations to include inactive resources.

Overrides:

withInactive in class AbstractResources<NetworkSystemRestRep>

Parameters:

inactive - whether to include inactive resources.

Returns:

this AbstractResources.

withInternal

public NetworkSystems withInternal(boolean internal)

Description copied from class: AbstractResources

Configures the fetch operations to include internal resources.

Overrides:

withInternal in class AbstractResources<NetworkSystemRestRep>

Parameters:

internal - whether to include internal resources.

Returns:

this AbstractResources.

getTasks

public Tasks<NetworkSystemRestRep> getTasks(java.net.URI id)

Description copied from interface: TaskResources

Gets the tasks associated with a given resource by ID.

API Call: GET baseUrl/{id}/tasks

Specified by:

getTasks in interface TaskResources<NetworkSystemRestRep>

Parameters:

id - the resource ID.

Returns:

the tasks for the resource.

getTask

public Task<NetworkSystemRestRep> getTask(java.net.URI id,
                                          java.net.URI taskId)

Description copied from interface: TaskResources

Gets a single task associated with a given resource by ID.

API Call: GET baseUrl/{id}/tasks/{taskId}

Specified by:

getTask in interface TaskResources<NetworkSystemRestRep>

Parameters:

id - the resource ID.

taskId - the task ID.

Returns:

the task.

list

public java.util.List<NamedRelatedResourceRep> list()

Lists all network systems.

API Call: GET /vdc/network-systems

Specified by:

list in interface TopLevelResources<NetworkSystemRestRep>

Returns:

the list of network system references.

getAll

public java.util.List<NetworkSystemRestRep> getAll()

Gets the list of all network systems. This is a convenience for getByRefs(list()).

Specified by:

getAll in interface TopLevelResources<NetworkSystemRestRep>

Returns:

the list of network systems.

See Also:

TopLevelResources.list(), Resources.getByRefs(java.util.Collection)

getAll

public java.util.List<NetworkSystemRestRep> getAll(ResourceFilter<NetworkSystemRestRep> filter)

Gets the list of all network systems, optionally filtering the results. This is a convenience for getByRefs(list(), filter).

Specified by:

getAll in interface TopLevelResources<NetworkSystemRestRep>

Parameters:

filter - the resource filter to apply to the results as they are returned (optional).

Returns:

the list of network systems.

See Also:

TopLevelResources.list(), Resources.getByRefs(java.util.Collection, ResourceFilter)

create

public Task<NetworkSystemRestRep> create(NetworkSystemCreate input)

Begins creating a network system.

API Call: POST /vdc/network-systems

Parameters:

input - the create configuration.

Returns:

a task for monitoring the progress of the operation.

update

public Task<NetworkSystemRestRep> update(java.net.URI id,
                                         NetworkSystemUpdate input)

Begins updating a network system by ID.

API Call: PUT /vdc/network-systems/{id}

Parameters:

id - the ID of the network system to update.

input - the update configuration.

Returns:

a task for monitoring the progress of the operation.

deactivate

public Task<NetworkSystemRestRep> deactivate(java.net.URI id)

Begins deactivating a network system by ID.

API Call: POST /vdc/network-systems/{id}

Parameters:

id - the ID of the network system to deactivate.

Returns:

a task for monitoring the progress of the operation.

register

public NetworkSystemRestRep register(java.net.URI id)

Registers the given network system by ID.

API Call: POST /vdc/network-systems/{id}/register

Parameters:

id - the ID of the network system to register.

Returns:

the network system.

deregister

public NetworkSystemRestRep deregister(java.net.URI id)

Deregisters the given network system by ID.

API Call: POST /vdc/network-systems/{id}/deregister

Parameters:

id - the ID of the network system to deregister.

Returns:

the network system.

discover

public Task<NetworkSystemRestRep> discover(java.net.URI id)

Begins discovery of the given network system by ID.

API Call: POST /vdc/network-systems/{id}/discover

Parameters:

id - the ID of the network system to discover.

Returns:

a task for monitoring the progress of the operation.

getFCEndpoints

public java.util.List<FCEndpointRestRep> getFCEndpoints(java.net.URI id,
                                                        java.lang.String fabricId)

Gets the list of FC endpoints in the given network system by ID.

API Call: GET [?fabric-id={fabric-id}]

Parameters:

id - the ID of the network system.

fabricId - the fabric ID, or null if there is no fabric.

Returns:

the list of FC endpoints.

getSanFabrics

public java.util.List<java.lang.String> getSanFabrics(java.net.URI id)

Gets the list of SAN fabric names in the given network system by ID.

API Call: GET

Parameters:

id - the ID of the network system.

Returns:

the list of SAN fabric names.

getSanZones

public java.util.List<SanZone> getSanZones(java.net.URI id,
                                           java.lang.String fabric)

Gets the list of SAN zones in the given network system by ID and fabric name.

API Call: GET

Parameters:

id - the ID of the network system.

fabric - the name of the fabric.

Returns:

the list of SAN zones.

addSanZones

public Task<NetworkSystemRestRep> addSanZones(java.net.URI id,
                                              java.lang.String fabric,
                                              SanZoneCreateParam input)

Adds SAN zones to the given network system by ID and fabric name.

API Call: POST

Parameters:

id - the ID of the network system.

fabric - the name of the fabric.

input - the SAN zones configuration.

Returns:

a task for monitoring the progress of the operation.

removeSanZones

public Task<NetworkSystemRestRep> removeSanZones(java.net.URI id,
                                                 java.lang.String fabric,
                                                 SanZonesDeleteParam input)

Removes a SAN zone from the given network system by ID and fabric name.

API Call: POST /remove

Parameters:

id - the ID of the network system.

fabric - the name of the fabric.

input - the SAN zones configuration.

Returns:

a task for monitoring the progress of the operation.

updateSanZones

public Task<NetworkSystemRestRep> updateSanZones(java.net.URI id,
                                                 java.lang.String fabric,
                                                 SanZoneUpdateParams input)

Updates a SAN zone from the given network system by ID and fabric name.

API Call: PUT

Parameters:

id - the ID of the network system.

fabric - the name of the fabric.

input - the SAN zones configuration.

Returns:

a task for monitoring the progress of the operation.

activateSanZones

public Task<NetworkSystemRestRep> activateSanZones(java.net.URI id,
                                                   java.lang.String fabric,
                                                   SanZones input)

Activates the current active zoneset of the fabric. This API assumes an active zoneset already exists. If the active zoneset became empty, this API deactivates it.

API Call: POST /activate

Parameters:

id - the ID of the network system.

fabric - the name of the fabric.

input - the SAN zones configuration.

Returns:

a task for monitoring the progress of the operation.

getAliases

public java.util.List<? extends WwnAliasParam> getAliases(java.net.URI id,
                                                          java.lang.String fabric)

Gets the list of WWN Aliases in the given network system by ID and fabric name.

API Call: GET [?fabric-id={fabric}]

Parameters:

id - the ID of the network system.

fabric - the name of the fabric, or null if there is no fabric.

Returns:

the list of WWN Aliases.

addAliases

public Task<NetworkSystemRestRep> addAliases(java.net.URI id,
                                             WwnAliasesCreateParam input)

Adds WWN Aliases to the given network system by ID and fabric name.

API Call: POST

Parameters:

id - the ID of the network system.

input - the WWN Aliases configuration.

Returns:

a task for monitoring the progress of the operation.

deleteAliases

public Task<NetworkSystemRestRep> deleteAliases(java.net.URI id,
                                                WwnAliasesDeleteParam input)

Removes WWN Aliases from the given network system by ID.

API Call: POST /remove

Parameters:

id - the ID of the network system.

input - the WWN Aliases configuration.

Returns:

a task for monitoring the progress of the operation.

updateAliases

public Task<NetworkSystemRestRep> updateAliases(java.net.URI id,
                                                WwnAliasUpdateParams input)

Updates WWN Aliases from the given network system by ID.

API Call: PUT

Parameters:

id - the ID of the network system.

input - the WWN Aliases configuration.

Returns:

a task for monitoring the progress of the operation.