purity_fb.NetworkInterfacesApi

All URIs are relative to https://purity_fb_server/api

Method	HTTP request	Description
create_network_interfaces	POST /1.3/network-interfaces
delete_network_interfaces	DELETE /1.3/network-interfaces
list_network_interfaces	GET /1.3/network-interfaces
update_network_interfaces	PATCH /1.3/network-interfaces

create_network_interfaces

NetworkInterfaceResponse create_network_interfaces(names=names, network_interface=network_interface)

Create a new network interface

Example

from purity_fb import PurityFb, rest, NetworkInterface

fb = PurityFb("10.255.9.28", version=__version__)  # assume the array IP is 10.255.9.28
fb.disable_verify_ssl()
try:
    res = fb.login(API_TOKEN)  # login to the array with your API_TOKEN
except rest.ApiException as e:
    print("Exception when logging in to the array: %s\n" % e)
if res:
    try:
        # create vip named myvip on the array
        res = fb.network_interfaces.create_network_interfaces(
            names=["myvip"],
            network_interface=NetworkInterface(address='1.2.3.101',
                                               services=["data"],
                                               type="vip"))
        print(res)
    except rest.ApiException as e:
        print("Exception when creating network interface: %s\n" % e)

Parameters

Name	Type	Description	Notes
names	list[str]	A list of names.	[optional]
network_interface	NetworkInterface	The attribute map used to create the network interface	[optional]

Return type

NetworkInterfaceResponse

Authorization

AuthTokenHeader

HTTP request headers

Content-Type: application/json
Accept: application/json

[Back to top] [Back to API list] [Back to Model list] [Back to Overview]

delete_network_interfaces

delete_network_interfaces(names=names)

Delete a network interface by name

Example

from purity_fb import PurityFb, rest

fb = PurityFb("10.255.9.28", version=__version__) # assume the array IP is 10.255.9.28
fb.disable_verify_ssl()
try:
    res = fb.login(API_TOKEN) # login to the array with your API_TOKEN
except rest.ApiException as e:
    print("Exception when logging in to the array: %s\n" % e)
if res:
    try:
        # delete a network interface with name myvip
        fb.network_interfaces.delete_network_interfaces(names=["myvip"])
    except rest.ApiException as e:
        print("Exception when deleting network interface: %s\n" % e)

Parameters

Name	Type	Description	Notes
names	list[str]	A list of names.	[optional]

Return type

void (empty response body)

Authorization

AuthTokenHeader

HTTP request headers

Content-Type: application/json
Accept: application/json

[Back to top] [Back to API list] [Back to Model list] [Back to Overview]

list_network_interfaces

NetworkInterfaceResponse list_network_interfaces(names=names, filter=filter, sort=sort, start=start, limit=limit, token=token)

List network interfaces

Example

from purity_fb import PurityFb, rest

fb = PurityFb("10.255.9.28") # assume the array IP is 10.255.9.28
fb.disable_verify_ssl()
try:
    res = fb.login(API_TOKEN) # login to the array with your API_TOKEN
except rest.ApiException as e:
    print("Exception when logging in to the array: %s\n" % e)
if res:
    try:
        # list all network interfaces
        res = fb.network_interfaces.list_network_interfaces()
        # list and sort by name in descendant order
        res = fb.network_interfaces.list_network_interfaces(limit=5, sort="name-")
        # list with page size 5
        res = fb.network_interfaces.list_network_interfaces(limit=5)
        # list all remaining network interfaces
        res = fb.network_interfaces.list_network_interfaces(token=res.pagination_info.continuation_token)
        # list with filter
        res = fb.network_interfaces.list_network_interfaces(filter='vlan=8')
    except rest.ApiException as e:
        print("Exception when listing network interfaces: %s\n" % e)```

### Parameters

Name | Type | Description  | Notes
------------- | ------------- | ------------- | -------------
 **names** | [**list[str]**](str.md)| A list of names. | [optional] 
 **filter** | **str**| The filter to be used for query. | [optional] 
 **sort** | **str**| The way to order the results. | [optional] 
 **start** | **int**| start | [optional] 
 **limit** | **int**| limit, should be &gt;&#x3D; 0 | [optional] 
 **token** | **str**| token | [optional] 

### Return type

[**NetworkInterfaceResponse**](NetworkInterfaceResponse.md)

### Authorization

[AuthTokenHeader](index.md#AuthTokenHeader)

### HTTP request headers

 - **Content-Type**: application/json
 - **Accept**: application/json

[[Back to top]](#) [[Back to API list]](index.md#endpoint-properties) [[Back to Model list]](index.md#documentation-for-models) [[Back to Overview]](index.md)

# **update_network_interfaces**
> NetworkInterfaceResponse update_network_interfaces(names=names, network_interface=network_interface)



Update an existing network interface

### Example 
```python
from purity_fb import PurityFb, rest

fb = PurityFb("10.255.9.28") # assume the array IP is 10.255.9.28
fb.disable_verify_ssl()
try:
    res = fb.login(API_TOKEN) # login to the array with your API_TOKEN
except rest.ApiException as e:
    print("Exception when logging in to the array: %s\n" % e)
if res:
    try:
        res = fb.network_interfaces.update_network_interfaces(
            names=['myvip'], network_interface=NetworkInterface(address='1.2.3.201'))
        print(res)
    except rest.ApiException as e:
        print("Exception when updating network interface: %s\n" % e)

Parameters

Name	Type	Description	Notes
names	list[str]	A list of names.	[optional]
network_interface	NetworkInterface	the attribute map used to update the network interface	[optional]

Return type

NetworkInterfaceResponse

Authorization

AuthTokenHeader

HTTP request headers

Content-Type: application/json
Accept: application/json

[Back to top] [Back to API list] [Back to Model list] [Back to Overview]