purity_fb_1dot12.SubnetsApi

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

Method HTTP request Description
create_subnets POST /1.12/subnets
delete_subnets DELETE /1.12/subnets
list_subnets GET /1.12/subnets
update_subnets PATCH /1.12/subnets

create_subnets

SubnetResponse create_subnets(names=names, subnet=subnet)

Create a new subnet.

Example

from purity_fb import PurityFb, rest, Subnet

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:
        # post the subnet object mysubnet on the array
        res = fb.subnets.create_subnets(names=["mysubnet"],
                                        subnet=Subnet(prefix='1.2.3.0/24'))
        print(res)
    except rest.ApiException as e:
        print("Exception when creating subnet: %s\n" % e)

Parameters

Name Type Description Notes
names list[str] A comma-separated list of resource names. This cannot be provided together with the ids query parameters. [optional]
subnet Subnet The attribute map used to create the subnet. [optional]

Return type

SubnetResponse

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_subnets

delete_subnets(ids=ids, names=names)

Delete a subnet.

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 subnet with name myobjsubnet
        fb.subnets.delete_subnets(names=["myobjsubnet"])
    except rest.ApiException as e:
        print("Exception when deleting subnet: %s\n" % e)

Parameters

Name Type Description Notes
ids list[str] A comma-separated list of resource IDs. This cannot be provided together with the name or names query parameters. [optional]
names list[str] A comma-separated list of resource names. This cannot be provided together with the ids query parameters. [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_subnets

SubnetResponse list_subnets(filter=filter, ids=ids, limit=limit, names=names, sort=sort, start=start, token=token)

List subnets.

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 subnets
        res = fb.subnets.list_subnets()
        # list and sort by name in descendant order
        res = fb.subnets.list_subnets(limit=5, sort="name-")
        # list with page size 5
        res = fb.subnets.list_subnets(limit=5)
        # list all remaining subnets
        res = fb.subnets.list_subnets(token=res.pagination_info.continuation_token)
        # list with filter
        res = fb.subnets.list_subnets(filter='contains(services, \'replication\')')
    except rest.ApiException as e:
        print("Exception when listing subnets: %s\n" % e)

Parameters

Name Type Description Notes
filter str The filter to be used for query. [optional]
ids list[str] A comma-separated list of resource IDs. This cannot be provided together with the name or names query parameters. [optional]
limit int limit, should be >= 0 [optional]
names list[str] A comma-separated list of resource names. This cannot be provided together with the ids query parameters. [optional]
sort str Sort the response by the specified fields (in descending order if '-' is appended to the field name). [optional]
start int The offset of the first resource to return from a collection. [optional]
token str An opaque token used to iterate over a collection. The token to use on the next request is returned in the `continuation_token` field of the result. [optional]

Return type

SubnetResponse

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]

update_subnets

SubnetResponse update_subnets(ids=ids, names=names, subnet=subnet)

Update an existing subnet.

Example

from purity_fb import PurityFb, rest, Subnet

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:
        # update a subnet's gateway by name
        res = fb.subnets.update_subnets(
            names=['myobjsubnet'], subnet=Subnet(gateway='1.2.3.1'))
        print(res)
    except rest.ApiException as e:
        print("Exception when updating subnet: %s\n" % e)

Parameters

Name Type Description Notes
ids list[str] A comma-separated list of resource IDs. This cannot be provided together with the name or names query parameters. [optional]
names list[str] A comma-separated list of resource names. This cannot be provided together with the ids query parameters. [optional]
subnet Subnet The attribute map used to update the subnet. [optional]

Return type

SubnetResponse

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]