net
Suggest changes
PDFs
data-lif-capacity
This ONTAPI call does not have an equivalent REST API call.
data-lif-capacity-details
This ONTAPI call does not have an equivalent REST API call.
net-active-routes-get
This ONTAPI call does not have an equivalent REST API call.
net-active-routes-get-iter
This ONTAPI call does not have an equivalent REST API call.
net-arp-active-entry-destroy
This ONTAPI call does not have an equivalent REST API call.
net-arp-active-entry-get
This ONTAPI call does not have an equivalent REST API call.
net-arp-active-entry-get-iter
This ONTAPI call does not have an equivalent REST API call.
net-arp-create
This ONTAPI call does not have an equivalent REST API call.
net-arp-destroy
This ONTAPI call does not have an equivalent REST API call.
net-arp-get
This ONTAPI call does not have an equivalent REST API call.
net-arp-get-iter
This ONTAPI call does not have an equivalent REST API call.
net-bgp-config-create
POST /api/network/ip/bgp/peer-groups
Usage: This ONTAPI call cannot be issued against Storage VM (SVM) management LIFs.
| ONTAPI attribute | REST attribute | Comment |
|---|---|---|
asn |
peer.asn |
|
hold-time |
No REST Equivalent |
|
node |
local.port.node.name |
|
return-record |
return_records |
|
router-id |
No REST Equivalent |
net-bgp-config-destroy
DELETE /api/network/ip/bgp/peer-groups/{uuid}
Usage: This ONTAPI call cannot be issued against Storage VM (SVM) management LIFs.
| ONTAPI attribute | REST attribute | Comment |
|---|---|---|
node |
No REST Equivalent |
The node is uniqely identified by the uuid. |
net-bgp-config-get
GET /api/network/ip/bgp/peer-groups/{uuid}
Usage: This ONTAPI call cannot be issued against Storage VM (SVM) management LIFs.
| ONTAPI attribute | REST attribute | Comment |
|---|---|---|
asn |
peer.asn |
|
hold-time |
No REST Equivalent |
|
node |
local.port.node.name |
|
router-id |
No REST Equivalent |
net-bgp-config-get-iter
GET /api/network/ip/bgp/peer-groups
Usage: This ONTAPI call cannot be issued against Storage VM (SVM) management LIFs.
| ONTAPI attribute | REST attribute | Comment |
|---|---|---|
asn |
peer.asn |
|
hold-time |
No REST Equivalent |
|
node |
local.port.node.name |
|
router-id |
No REST Equivalent |
|
max-records |
max_records |
The maximum number of records to return before paging |
net-bgp-config-modify
PATCH /api/network/ip/bgp/peer-groups/{uuid}
Usage: This ONTAPI call cannot be issued against Storage VM (SVM) management LIFs.
| ONTAPI attribute | REST attribute | Comment |
|---|---|---|
asn |
peer.asn |
|
hold-time |
No REST Equivalent |
|
node |
No REST Equivalent |
|
router-id |
No REST Equivalent |
net-bgp-defaults-get
This ONTAPI call does not have an equivalent REST API call.
net-bgp-defaults-modify
This ONTAPI call does not have an equivalent REST API call.
net-bgp-peer-group-create
POST /api/network/ip/bgp/peer-groups
Usage: This ONTAPI call cannot be issued against Storage VM (SVM) management LIFs.
| ONTAPI attribute | REST attribute | Comment |
|---|---|---|
bgp-lif |
local.interface.name |
Alternatively, you can specify "local.interface.uuid". The ipspace.name or ipspace.uuid is required when you specify the local interface. Refer to the REST API documentation for the usage of local.ip and local.port parameters. |
ipspace |
ipspace.name |
|
peer-address |
peer.address |
|
peer-asn |
peer.asn |
|
peer-group |
name |
|
route-preference |
No REST Equivalent |
net-bgp-peer-group-destroy
DELETE /api/network/ip/bgp/peer-groups/{uuid}
Usage: This ONTAPI call cannot be issued against Storage VM (SVM) management LIFs.
| ONTAPI attribute | REST attribute | Comment |
|---|---|---|
ipspace |
No REST Equivalent |
|
peer-group |
No REST Equivalent |
net-bgp-peer-group-get
GET /api/network/ip/bgp/peer-groups/{uuid}
Usage: This ONTAPI call cannot be issued against Storage VM (SVM) management LIFs.
| ONTAPI attribute | REST attribute | Comment |
|---|---|---|
bgp-lif |
local.interface.name |
|
bgp-node |
local.port.node.name |
|
bgp-port |
local.port.name |
Alternatively, you can use "local.port.uuid". |
ipspace |
ipspace.name |
|
peer-address |
peer.address |
|
peer-asn |
peer.asn |
|
peer-group |
name |
|
route-preference |
No REST Equivalent |
|
state |
state |
net-bgp-peer-group-get-iter
GET /api/network/ip/bgp/peer-groups
Usage: This ONTAPI call cannot be issued against Storage VM (SVM) management LIFs.
| ONTAPI attribute | REST attribute | Comment |
|---|---|---|
bgp-lif |
local.interface.name |
|
bgp-node |
local.port.node.name |
|
bgp-port |
local.port.name |
Alternatively, you can use "local.port.uuid". |
ipspace |
ipspace.name |
|
peer-address |
peer.address |
|
peer-asn |
peer.asn |
|
peer-group |
name |
|
route-preference |
No REST Equivalent |
|
state |
state |
|
max-records |
max_records |
Specifies the maximum number of records to return before paging. |
net-bgp-peer-group-modify
PATCH /api/network/ip/bgp/peer-groups/{uuid}
Usage: This ONTAPI call cannot be issued against Storage VM (SVM) management LIFs.
| ONTAPI attribute | REST attribute | Comment |
|---|---|---|
ipspace |
ipspace.name |
|
peer-address |
peer.address |
|
peer-group |
No REST Equivalent |
net-bgp-peer-group-rename
PATCH /api/network/ip/bgp/peer-groups/{uuid}
Usage: This ONTAPI call cannot be issued against Storage VM (SVM) management LIFs.
| ONTAPI attribute | REST attribute | Comment |
|---|---|---|
ipspace |
ipspace.name |
|
new-name |
No REST Equivalent |
|
peer-group |
name |
net-bgp-vserver-status-get
This ONTAPI call does not have an equivalent REST API call.
net-bgp-vserver-status-get-iter
This ONTAPI call does not have an equivalent REST API call.
net-check-failover
This ONTAPI call does not have an equivalent REST API call.
net-cluster-ping
This ONTAPI call does not have an equivalent REST API call.
net-cluster-ping6
This ONTAPI call does not have an equivalent REST API call.
net-connections-receive-window-size-get
This ONTAPI call does not have an equivalent REST API call.
net-connections-receive-window-size-get-iter
This ONTAPI call does not have an equivalent REST API call.
net-connections-receive-window-size-modify
This ONTAPI call does not have an equivalent REST API call.
net-ddns-get
GET /api/name-services/dns
Note: Dynamic DNS is added as an object in DNS endpoint.
Usage: This ONTAPI call can be issued against Storage VM (SVM) management LIFs.
| ONTAPI attribute | REST attribute | Comment |
|---|---|---|
domain-name |
fqdn |
|
is-enabled |
enabled |
|
skip-fqdn-validation |
skip_fqdn_validation |
|
ttl |
time_to_live |
|
use-secure |
use_secure |
|
vserver-name |
svm.name |
net-ddns-get-iter
GET /api/name-services/dns/{uuid}
Note: Dynamic DNS is added as an object in DNS endpoint.
Usage: This ONTAPI call can be issued against Storage VM (SVM) management LIFs.
| ONTAPI attribute | REST attribute | Comment |
|---|---|---|
domain-name |
fqdn |
|
is-enabled |
enabled |
|
skip-fqdn-validation |
skip_fqdn_validation |
|
ttl |
time_to_live |
|
use-secure |
use_secure |
|
vserver-name |
svm.name |
|
max-records |
No REST Equivalent |
Maximum number of records applies to the DNS GET endpoint. |
net-ddns-modify
PATCH /api/name-services/dns/{uuid}
Note: Dynamic DNS is added as an object in DNS endpoint.
Usage: This ONTAPI call can be issued against Storage VM (SVM) management LIFs.
| ONTAPI attribute | REST attribute | Comment |
|---|---|---|
domain-name |
fqdn |
|
is-enabled |
enabled |
|
skip-fqdn-validation |
skip_fqdn_validation |
|
ttl |
time_to_live |
|
use-secure |
use_secure |
net-device-discovery-get-iter
GET /api/network/ethernet/ports
Usage: This ONTAPI call cannot be issued against Storage VM (SVM) management LIFs.
| ONTAPI attribute | REST attribute | Comment |
|---|---|---|
capabilities |
discovered_devices.capabilities |
|
chassis-id |
discovered_devices.chassis_id |
|
device-ip |
discovered_devices.ip_addresses |
|
discovered-device |
discovered_devices.name |
|
hold-time-remaining |
discovered_devices.remaining_hold_time |
|
interface |
discovered_devices.remote_port |
|
node |
node.name |
|
platform |
discovered_devices.platform |
|
port |
name |
|
protocol |
discovered_devices.protocol |
|
system-name |
discovered_devices.system_name |
|
version |
discovered_devices.version |
|
max-records |
No REST Equivalent |
Maximum number of records applies to the port GET endpoint. |
net-disable-readonly
This ONTAPI call does not have an equivalent REST API call.
net-dns-check-get-iter
GET /api/name-services/dns
Note: DNS check is an advanced parameter in DNS GET endpoint. It can be fetched using fields=**
or fields=status.
Usage: This ONTAPI call can be issued against Storage VM (SVM) management LIFs.
| ONTAPI attribute | REST attribute | Comment |
|---|---|---|
name-server |
name_server |
|
status |
state |
|
status-details |
message |
|
vserver |
svm.name |
|
max-records |
No REST Equivalent |
Maximum number of records applies to the DNS GET endpoint. |
net-dns-create
POST /api/name-services/dns
Usage: This ONTAPI call can be issued against Storage VM (SVM) management LIFs.
| ONTAPI attribute | REST attribute | Comment |
|---|---|---|
attempts |
attempts |
|
dns-state |
No REST Equivalent |
This field has been deprecated in the REST API. State is by default enabled when DNS is configured. |
domains |
domains |
|
is-tld-query-enabled |
tld_query_enabled |
|
name-servers |
servers |
|
require-packet-query-match |
packet_query_match |
|
require-source-address-match |
source_address_match |
|
return-record |
return_records |
|
skip-config-validation |
skip_config_validation |
|
timeout |
timeout |
net-dns-destroy
DELETE /api/name-services/dns/{uuid}
Usage: This ONTAPI call can be issued against Storage VM (SVM) management LIFs.
There are no attributes defined for this ONTAPI call.
net-dns-get
GET /api/name-services/dns/{uuid}
Usage: This ONTAPI call can be issued against Storage VM (SVM) management LIFs.
| ONTAPI attribute | REST attribute | Comment |
|---|---|---|
attempts |
attempts |
|
dns-state |
No REST Equivalent |
This field has been deprecated in the REST API. State is by default enabled when DNS is configured. |
domains |
domains |
|
is-tld-query-enabled |
tld_query_enabled |
This field is an advanced parameter in DNS GET endpoint. It can be fetched using 'fields=**' |
name-servers |
servers |
|
require-packet-query-match |
packet_query_match |
This field is an advanced parameter in DNS GET endpoint. It can be fetched using 'fields=**' |
require-source-address-match |
source_address_match |
This field is an advanced parameter in DNS GET endpoint. It can be fetched using 'fields=**' |
skip-config-validation |
skip_config_validation |
|
timeout |
timeout |
|
vserver-name |
svm.name |
net-dns-get-iter
GET /api/name-services/dns
Usage: This ONTAPI call can be issued against Storage VM (SVM) management LIFs.
| ONTAPI attribute | REST attribute | Comment |
|---|---|---|
attempts |
attempts |
|
dns-state |
No REST Equivalent |
This field has been deprecated in the REST API. State is by default enabled when DNS is configured. |
domains |
domains |
|
is-tld-query-enabled |
tld_query_enabled |
This field is an advanced parameter in DNS GET endpoint. It can be fetched using 'fields=**' |
name-servers |
servers |
|
require-packet-query-match |
packet_query_match |
This field is an advanced parameter in DNS GET endpoint. It can be fetched using 'fields=**' |
require-source-address-match |
source_address_match |
This field is an advanced parameter in DNS GET endpoint. It can be fetched using 'fields=**' |
skip-config-validation |
skip_config_validation |
|
timeout |
timeout |
|
vserver-name |
svm.name |
|
max-records |
max_records |
Specifies the maximum number of records to return before paging. |
net-dns-modify
PATCH /api/name-services/dns/{uuid}
Usage: This ONTAPI call can be issued against Storage VM (SVM) management LIFs.
| ONTAPI attribute | REST attribute | Comment |
|---|---|---|
attempts |
attempts |
|
dns-state |
No REST Equivalent |
This field has been deprecated in the REST API. State is by default enabled when DNS is configured. |
domains |
domains |
|
is-tld-query-enabled |
tld_query_enabled |
|
name-servers |
servers |
|
require-packet-query-match |
packet_query_match |
|
require-source-address-match |
source_address_match |
|
skip-config-validation |
skip_config_validation |
|
timeout |
timeout |
net-enable-readonly
This ONTAPI call does not have an equivalent REST API call.
net-external-route-table-create
Note: This ONTAPI is published as an unsupported ONTAPI. It is available through the REST API by using the CLI passthrough /api/private/cli/network/cloud/routing-table.
This ONTAPI call does not have an equivalent REST API call.
net-external-route-table-delete
Note: This ONTAPI is published as an unsupported ONTAPI. It is available through the REST API by using the CLI passthrough /api/private/cli/network/cloud/routing-table.
This ONTAPI call does not have an equivalent REST API call.
net-failover-group-add-targets
Note: The common practice will be to use default failover groups, which are all the ports of a broadcast domain. Custom failover groups are not presented in the REST API. Refer to the /api/network/ethernet/broadcast-domains/ REST API endpoint for documentation on broadcast domains.
This ONTAPI call does not have an equivalent REST API call.
net-failover-group-create
Note: The common practice will be to use default failover groups, which are all the ports of a broadcast domain. Custom failover groups are not presented in the REST API. Refer to the /api/network/ethernet/broadcast-domains/ REST API endpoint for documentation on broadcast domains.
This ONTAPI call does not have an equivalent REST API call.
net-failover-group-destroy
Note: The common practice will be to use default failover groups, which are all the ports of a broadcast domain. Custom failover groups are not presented in the REST API. Refer to the /api/network/ethernet/broadcast-domains/ REST API endpoint for documentation on broadcast domains.
This ONTAPI call does not have an equivalent REST API call.
net-failover-group-get
Note: The common practice will be to use default failover groups, which are all the ports of a broadcast domain. Custom failover groups are not presented in the REST API. Refer to the /api/network/ethernet/broadcast-domains/ REST API endpoint for documentation on broadcast domains.
This ONTAPI call does not have an equivalent REST API call.
net-failover-group-get-iter
Note: The common practice will be to use default failover groups, which are all the ports of a broadcast domain. Custom failover groups are not presented in the REST API. Refer to the /api/network/ethernet/broadcast-domains/ REST API endpoint for documentation on broadcast domains.
This ONTAPI call does not have an equivalent REST API call.
net-failover-group-modify
Note: The common practice will be to use default failover groups, which are all the ports of a broadcast domain. Custom failover groups are not presented in the REST API. Refer to the /api/network/ethernet/broadcast-domains/ REST API endpoint for documentation on broadcast domains.
This ONTAPI call does not have an equivalent REST API call.
net-failover-group-remove-targets
Note: The common practice will be to use default failover groups, which are all the ports of a broadcast domain. Custom failover groups are not presented in the REST API. Refer to the /api/network/ethernet/broadcast-domains/ REST API endpoint for documentation on broadcast domains.
This ONTAPI call does not have an equivalent REST API call.
net-failover-group-rename
Note: The common practice will be to use default failover groups, which are all the ports of a broadcast domain. Custom failover groups are not presented in the REST API. Refer to the /api/network/ethernet/broadcast-domains/ REST API endpoint for documentation on broadcast domains.
This ONTAPI call does not have an equivalent REST API call.
net-firewall-config-get
Note: Firewall policies are deprecated in favor of service policies. Refer to the /api/network/ip/service-policies/ REST API documentation.
This ONTAPI call does not have an equivalent REST API call.
net-firewall-config-get-iter
Note: Firewall policies are deprecated in favor of service policies. Refer to the /api/network/ip/service-policies/ REST API documentation.
This ONTAPI call does not have an equivalent REST API call.
net-firewall-config-modify
Note: Firewall policies are deprecated in favor of service policies. Refer to the /api/network/ip/service-policies/ REST API documentation.
This ONTAPI call does not have an equivalent REST API call.
net-firewall-config-modify-iter
Note: Firewall policies are deprecated in favor of service policies. Refer to the /api/network/ip/service-policies/ REST API documentation.
This ONTAPI call does not have an equivalent REST API call.
net-firewall-policy-create
Note: Firewall policies are deprecated in favor of service policies. Refer to the /api/network/ip/service-policies/ REST API documentation.
This ONTAPI call does not have an equivalent REST API call.
net-firewall-policy-destroy
Note: Firewall policies are deprecated in favor of service policies. Refer to the /api/network/ip/service-policies/ REST API documentation.
This ONTAPI call does not have an equivalent REST API call.
net-firewall-policy-get
Note: Firewall policies are deprecated in favor of service policies. Refer to the /api/network/ip/service-policies/ REST API documentation.
This ONTAPI call does not have an equivalent REST API call.
net-firewall-policy-get-iter
Note: Firewall policies are deprecated in favor of service policies. Refer to the /api/network/ip/service-policies/ REST API documentation.
This ONTAPI call does not have an equivalent REST API call.
net-firewall-policy-modify
Note: Firewall policies are deprecated in favor of service policies. Refer to the /api/network/ip/service-policies/ REST API documentation.
This ONTAPI call does not have an equivalent REST API call.
net-hosts-create
POST /api/name-services/local-hosts
Usage: This ONTAPI call can be issued against Storage VM (SVM) management LIFs.
| ONTAPI attribute | REST attribute | Comment |
|---|---|---|
aliases |
aliases |
|
host-ip-address |
address |
|
hostname |
hostname |
|
vserver |
owner.uuid |
Can also use owner.name. Since we have used the scope variable in REST, we have a change in variable name of the vserver. |
return-record |
return_records |
net-hosts-destroy
DELETE /api/name-services/local-hosts/{owner.uuid}/{address}
Usage: This ONTAPI call can be issued against Storage VM (SVM) management LIFs.
| ONTAPI attribute | REST attribute | Comment |
|---|---|---|
host-ip-address |
address |
|
vserver |
owner.uuid |
Since we have used the scope variable in REST, we have a change in variable name of the vserver. |
net-hosts-get
GET /api/name-services/local-hosts/{owner.uuid}/{address}
Usage: This ONTAPI call can be issued against Storage VM (SVM) management LIFs.
| ONTAPI attribute | REST attribute | Comment |
|---|---|---|
aliases |
aliases |
|
host-ip-address |
address |
|
hostname |
hostname |
|
vserver-name |
owner.name |
Since we have used the scope variable in REST, we have a change in variable name of the vserver. |
net-hosts-get-iter
GET /api/name-services/local-hosts
Usage: This ONTAPI call can be issued against Storage VM (SVM) management LIFs.
| ONTAPI attribute | REST attribute | Comment |
|---|---|---|
aliases |
aliases |
|
host-ip-address |
address |
|
hostname |
hostname |
|
vserver-name |
owner.name |
Since we have used the scope variable in REST, we have a change in variable name of the vserver. |
max-records |
max_records |
net-hosts-modify
PATCH /api/name-services/local-hosts/{owner.uuid}/{address}
Usage: This ONTAPI call can be issued against Storage VM (SVM) management LIFs.
| ONTAPI attribute | REST attribute | Comment |
|---|---|---|
aliases |
aliases |
|
host-ip-address |
address |
|
hostname |
hostname |
|
vserver |
owner.uuid |
Since we have used the scope variable in REST, we have a change in variable name of the vserver. |
net-interface-create
POST /api/network/ip/interfaces
Usage: This ONTAPI call cannot be issued against Storage VM (SVM) management LIFs.
| ONTAPI attribute | REST attribute | Comment |
|---|---|---|
address |
ip.address |
|
administrative-status |
enabled |
|
comment |
No REST Equivalent |
|
data-protocols |
service_policy.uuid |
In the REST API, data-protocols are deprecated and replaced with service_policy. |
dns-domain-name |
dns_zone |
|
failover-group |
location.broadcast_domain.uuid |
In the REST API, failover-group is defined by the broadcast-domain. |
failover-policy |
location.failover |
|
firewall-policy |
service_policy.uuid |
|
force-subnet-association |
fail_if_subnets_conflict |
The mapped fields are opposite in behavior i.e. setting force-subnet-association to TRUE is equivalent to setting fail_if_subnets_conflict to FALSE and vice versa. |
home-node |
location.home_node |
|
home-port |
location.home_port |
|
interface-name |
name |
|
is-auto-revert |
location.auto_revert |
|
is-dns-update-enabled |
ddns_enabled |
|
is-ipv4-link-local |
No REST Equivalent |
|
is-vip |
vip |
|
listen-for-dns-query |
No REST Equivalent |
|
netmask |
ip.netmask |
|
netmask-length |
ip.netmask |
|
probe-port |
probe_port |
|
return-record |
return_records |
|
role |
service_policy.uuid |
|
routing-group-name |
No REST Equivalent |
This field is deprecated. |
service-policy |
service_policy.name |
|
subnet-name |
subnet.name |
Also subnet.uuid uniquely identifies a subnet. Use /api/network/ip/subnets GET to get the list of subnets. |
use-failover-group |
No REST Equivalent |
For the REST API, refer to broadcast-domains. |
vserver |
svm.name |
The svm.uuid uniquely identifies an SVM. |
net-interface-delete
DELETE /api/network/ip/interfaces/{uuid}
Usage: This ONTAPI call cannot be issued against Storage VM (SVM) management LIFs.
| ONTAPI attribute | REST attribute | Comment |
|---|---|---|
interface-name |
No REST Equivalent |
The interface UUID uniquely identifies the interface-name. |
vserver |
No REST Equivalent |
net-interface-get
GET /api/network/ip/interfaces/{uuid}
Usage: This ONTAPI call can be issued against Storage VM (SVM) management LIFs.
| ONTAPI attribute | REST attribute | Comment |
|---|---|---|
address |
ip.address |
|
address-family |
ip.family |
|
administrative-status |
enabled |
|
comment |
No REST Equivalent |
|
current-node |
location.node.name |
|
current-port |
location.port.name |
|
data-protocols |
services |
|
dns-domain-name |
dns_zone |
|
extended-status |
No REST Equivalent |
|
failover-group |
No REST Equivalent |
For the REST API, refer to broadcast-domains. |
failover-policy |
location.failover |
|
force-subnet-association |
No REST Equivalent |
|
home-node |
location.home_node.name |
|
home-port |
location.home_port.name |
|
interface-name |
name |
|
ipspace |
ipspace.name |
|
is-auto-revert |
location.auto_revert |
|
is-dns-update-enabled |
ddns_enabled |
|
is-home |
location.is_home |
|
is-ipv4-link-local |
No REST Equivalent |
|
is-vip |
vip |
|
lif-uuid |
uuid |
|
listen-for-dns-query |
No REST Equivalent |
|
netmask |
No REST Equivalent |
For the REST API, refer to "ip.netmask". |
netmask-length |
ip.netmask |
|
operational-status |
state |
|
probe-port |
probe_port |
|
role |
services |
|
routing-group-name |
No REST Equivalent |
This field is deprecated. |
service-names |
services |
|
service-policy |
service_policy.name |
|
subnet-name |
No REST Equivalent |
|
use-failover-group |
No REST Equivalent |
For the REST API, refer to broadcast-domains. |
vserver |
svm.name |
The svm.uuid uniquely identifies an SVM. |
wwpn |
No REST Equivalent |
For the REST API, refer to the /api/network/fc/interfaces endpoint for this field. |
net-interface-get-iter
GET /api/network/ip/interfaces
Usage: This ONTAPI call can be issued against Storage VM (SVM) management LIFs.
| ONTAPI attribute | REST attribute | Comment |
|---|---|---|
address |
ip.address |
|
address-family |
ip.family |
|
administrative-status |
enabled |
|
comment |
No REST Equivalent |
|
current-node |
location.node.name |
|
current-port |
location.port.name |
|
data-protocols |
services |
|
dns-domain-name |
dns_zone |
|
extended-status |
No REST Equivalent |
|
failover-group |
No REST Equivalent |
For the REST API, refer to broadcast-domains. |
firewall-policy |
service_policy.uuid |
|
force-subnet-association |
No REST Equivalent |
|
home-node |
location.home_node.name |
|
home-port |
location.home_port.name |
|
interface-name |
name |
|
ipspace |
ipspace.name |
|
is-auto-revert |
location.auto_revert |
|
is-dns-update-enabled |
ddns_enabled |
|
is-home |
location.is_home |
|
is-ipv4-link-local |
No REST Equivalent |
|
is-vip |
vip |
|
lif-uuid |
uuid |
|
listen-for-dns-query |
No REST Equivalent |
|
netmask |
ip.netmask |
|
netmask-length |
ip.netmask |
|
operational-status |
state |
|
probe-port |
probe_port |
|
role |
services |
|
routing-group-name |
No REST Equivalent |
This field is deprecated. |
service-names |
services |
|
service-policy |
service_policy.name |
|
subnet-name |
No REST Equivalent |
|
use-failover-group |
No REST Equivalent |
For the REST API, refer to broadcast-domains. |
vserver |
svm.name |
The svm.uuid uniquely identifies an SVM. |
wwpn |
No REST Equivalent |
For the REST API, refer to the /api/network/fc/interfaces endpoint for this field. |
max-records |
max_records |
Specifies the maximum number of records to return before paging. |
net-interface-migrate
PATCH /api/network/ip/interfaces/{uuid}
Usage: This ONTAPI call cannot be issued against Storage VM (SVM) management LIFs.
| ONTAPI attribute | REST attribute | Comment |
|---|---|---|
destination-node |
location.node.name |
|
destination-port |
location.port.name |
|
force |
No REST Equivalent |
|
lif |
No REST Equivalent |
|
vserver |
svm.name |
The svm.uuid uniquely identifies an SVM. |
net-interface-modify
PATCH /api/network/ip/interfaces/{uuid}
Usage: This ONTAPI call cannot be issued against Storage VM (SVM) management LIFs.
| ONTAPI attribute | REST attribute | Comment |
|---|---|---|
address |
ip.address |
|
administrative-status |
enabled |
|
comment |
No REST Equivalent |
|
dns-domain-name |
dns_zone |
|
failover-group |
No REST Equivalent |
For the REST API, refer to broadcast-domains. |
failover-policy |
location.failover |
|
firewall-policy |
service_policy.uuid |
|
force-subnet-association |
fail_if_subnets_conflict |
The mapped fields are opposite in behavior i.e. setting force-subnet-association to TRUE is equivalent to setting fail_if_subnets_conflict to FALSE and vice versa. |
home-node |
location.home_node.name |
|
home-port |
location.home_port.name |
|
interface-name |
name |
|
is-auto-revert |
location.auto_revert |
|
is-dns-update-enabled |
ddns_enabled |
|
listen-for-dns-query |
No REST Equivalent |
|
netmask |
No REST Equivalent |
|
netmask-length |
ip.netmask |
|
routing-group-name |
No REST Equivalent |
This field is deprecated. |
service-policy |
service_policy.name |
|
subnet-name |
subnet.name |
Also subnet.uuid uniquely identifies a subnet. Use /api/network/ip/subnets GET to get the list of subnets. |
use-failover-group |
No REST Equivalent |
For the REST API, refer to broadcast-domains. |
vserver |
svm.name |
The svm.uuid uniquely identifies an SVM. |
net-interface-modify-iter
PATCH /api/network/ip/interfaces/{uuid}
Usage: This ONTAPI call cannot be issued against Storage VM (SVM) management LIFs.
| ONTAPI attribute | REST attribute | Comment |
|---|---|---|
address |
ip.address |
|
address-family |
ip.family |
|
administrative-status |
enabled |
|
comment |
No REST Equivalent |
|
current-node |
location.node.name |
|
current-port |
location.port.name |
|
data-protocols |
service_policy.uuid |
In the REST API, data-protocols are deprecated and replaced with service_policy. |
dns-domain-name |
dns_zone |
|
extended-status |
No REST Equivalent |
|
failover-group |
No REST Equivalent |
For the REST API, refer to broadcast-domains. |
failover-policy |
location.failover |
|
firewall-policy |
service_policy.uuid |
|
force-subnet-association |
fail_if_subnets_conflict |
The mapped fields are opposite in behavior i.e. setting force-subnet-association to TRUE is equivalent to setting fail_if_subnets_conflict to FALSE and vice versa. |
home-node |
location.home_node.name |
|
home-port |
location.home_port.name |
|
interface-name |
name |
|
ipspace |
ipspace.name |
|
is-auto-revert |
location.auto_revert |
|
is-dns-update-enabled |
ddns_enabled |
|
is-home |
location.is_home |
|
is-ipv4-link-local |
No REST Equivalent |
|
is-vip |
vip |
|
lif-uuid |
uuid |
|
listen-for-dns-query |
No REST Equivalent |
|
netmask |
No REST Equivalent |
For the REST API, refer to "ip.netmask". |
netmask-length |
ip.netmask |
|
operational-status |
state |
|
probe-port |
No REST Equivalent |
|
role |
service_policy.uuid |
|
routing-group-name |
No REST Equivalent |
This field is deprecated. |
service-names |
services |
|
service-policy |
service_policy.name |
|
subnet-name |
subnet.name |
Also subnet.uuid uniquely identifies a subnet. Use /api/network/ip/subnets GET to get the list of subnets. |
use-failover-group |
No REST Equivalent |
For the REST API, refer to broadcast-domains. |
vserver |
svm.name |
The svm.uuid uniquely identifies an SVM. |
wwpn |
No REST Equivalent |
For the REST API, refer to the /api/network/fc/interfaces endpoint for this field. |
continue-on-failure |
No REST Equivalent |
|
max-failure-count |
No REST Equivalent |
|
max-records |
max_records |
Specifies the maximum number of records to return before paging. |
return-failure-list |
No REST Equivalent |
|
return-success-list |
No REST Equivalent |
net-interface-rename
PATCH /api/network/ip/interfaces/{uuid}
Usage: This ONTAPI call cannot be issued against Storage VM (SVM) management LIFs.
| ONTAPI attribute | REST attribute | Comment |
|---|---|---|
interface-name |
No REST Equivalent |
|
new-name |
name |
|
vserver |
svm.name |
The svm.uuid uniquely identifies an SVM. |
net-interface-revert
PATCH /api/network/ip/interfaces/{uuid}
Usage: This ONTAPI call cannot be issued against Storage VM (SVM) management LIFs.
| ONTAPI attribute | REST attribute | Comment |
|---|---|---|
interface-name |
name |
|
vserver |
No REST Equivalent |
The SVM is implied by the interface UUID. |
net-interface-service-get
GET /api/network/ip/service-policies/{uuid}
Usage: This ONTAPI call cannot be issued against Storage VM (SVM) management LIFs.
| ONTAPI attribute | REST attribute | Comment |
|---|---|---|
failover-policy |
No REST Equivalent |
In the REST API, this information is exposed in the "location.failover" field in the /api/network/ip/interfaces endpoint. |
ports |
No REST Equivalent |
|
service |
No REST Equivalent |
|
vserver-policy |
No REST Equivalent |
|
service |
No REST Equivalent |
net-interface-service-get-iter
GET /api/network/ip/service-policies
Usage: This ONTAPI call cannot be issued against Storage VM (SVM) management LIFs.
| ONTAPI attribute | REST attribute | Comment |
|---|---|---|
failover-policy |
No REST Equivalent |
In the REST API, this information is exposed in the location.failover field in the /api/network/ip/interfaces endpoint. |
ports |
No REST Equivalent |
|
service |
No REST Equivalent |
|
vserver-policy |
No REST Equivalent |
|
max-records |
max_records |
Specifies the maximum number of records to return before paging. |
net-interface-service-policy-add-service
PATCH /api/network/ip/service-policies/{uuid}
Usage: This ONTAPI call cannot be issued against Storage VM (SVM) management LIFs.
| ONTAPI attribute | REST attribute | Comment |
|---|---|---|
allowed-addresses |
No REST Equivalent |
allowed-address list defaults to 0.0.0.0/0 in REST |
policy |
No REST Equivalent |
policy is implied by service-policy's uuid |
service |
services |
|
vserver |
No REST Equivalent |
vserver is implied by service-policy's uuid |
net-interface-service-policy-clone
POST /api/network/ip/service-policies
Note: First a GET /api/network/ip/service-policies needs to be done on the specific service policy to be cloned, to fetch the list of services associated with it and followed by a POST to create a new one.
Usage: This ONTAPI call cannot be issued against Storage VM (SVM) management LIFs.
| ONTAPI attribute | REST attribute | Comment |
|---|---|---|
policy |
No REST Equivalent |
The policy would be specified in the GET response (name field) of the service policy to be cloned. |
target-policy |
name |
|
target-vserver |
svm.name |
svm.uuid also uniquely identifies the vserver. For system vserver, use ipspace.name and/or ipspace.uuid |
vserver |
No REST Equivalent |
The vserver would be specified in the GET response (svm.name field) of the service policy to be cloned. |
net-interface-service-policy-create
POST /api/network/ip/service-policies
Usage: This ONTAPI call cannot be issued against Storage VM (SVM) management LIFs.
| ONTAPI attribute | REST attribute | Comment |
|---|---|---|
policy |
name |
|
return-record |
return_records |
|
services |
services |
|
vserver |
svm |
For system vserver, use ipspace.name and/or ipspace.uuid |
net-interface-service-policy-destroy
DELETE /api/network/ip/service-policies/{uuid}
Usage: This ONTAPI call cannot be issued against Storage VM (SVM) management LIFs.
| ONTAPI attribute | REST attribute | Comment |
|---|---|---|
policy |
No REST Equivalent |
policy is implied by service-policy's uuid |
vserver |
No REST Equivalent |
vserver is implied by service-policy's uuid |
net-interface-service-policy-entry-get
GET /api/network/ip/service-policies/{uuid}
Usage: This ONTAPI call can be issued against Storage VM (SVM) management LIFs.
| ONTAPI attribute | REST attribute | Comment |
|---|---|---|
allowed-addresses |
No REST Equivalent |
|
policy |
No REST Equivalent |
|
service |
services |
|
vserver |
No REST Equivalent |
|
policy |
No REST Equivalent |
|
service |
No REST Equivalent |
net-interface-service-policy-entry-get-iter
GET /api/network/ip/service-policies
Usage: This ONTAPI call cannot be issued against Storage VM (SVM) management LIFs.
| ONTAPI attribute | REST attribute | Comment |
|---|---|---|
allowed-addresses |
No REST Equivalent |
|
policy |
No REST Equivalent |
|
service |
services |
|
vserver |
No REST Equivalent |
|
max-records |
max_records |
Specifies the maximum number of records to return before paging. |
net-interface-service-policy-get
GET /api/network/ip/service-policies/{uuid}
Usage: This ONTAPI call can be issued against Storage VM (SVM) management LIFs.
| ONTAPI attribute | REST attribute | Comment |
|---|---|---|
is-built-in |
No REST Equivalent |
|
policy |
No REST Equivalent |
|
services |
services |
|
vserver |
svm.name |
|
policy |
No REST Equivalent |
net-interface-service-policy-get-iter
GET /api/network/ip/service-policies
Usage: This ONTAPI call can be issued against Storage VM (SVM) management LIFs.
| ONTAPI attribute | REST attribute | Comment |
|---|---|---|
is-built-in |
No REST Equivalent |
|
policy |
No REST Equivalent |
|
services |
services |
|
vserver |
svm.name |
|
max-records |
max_records |
Specifies the maximum number of records to return before paging. |
net-interface-service-policy-modify-service
This ONTAPI call does not have an equivalent REST API call.
net-interface-service-policy-remove-service
This ONTAPI call does not have an equivalent REST API call.
net-interface-service-policy-rename
This ONTAPI call does not have an equivalent REST API call.
net-interface-service-policy-restore-defaults
This ONTAPI call does not have an equivalent REST API call.
net-ipspaces-assign-vserver
This ONTAPI call does not have an equivalent REST API call.
net-ipspaces-create
POST /api/network/ipspaces
Usage: This ONTAPI call cannot be issued against Storage VM (SVM) management LIFs.
| ONTAPI attribute | REST attribute | Comment |
|---|---|---|
ipspace |
name |
|
return-record |
return_records |
net-ipspaces-destroy
DELETE /api/network/ipspaces/{uuid}
Usage: This ONTAPI call cannot be issued against Storage VM (SVM) management LIFs.
| ONTAPI attribute | REST attribute | Comment |
|---|---|---|
ipspace |
name |
net-ipspaces-get
GET /api/network/ipspaces/{uuid}
Usage: This ONTAPI call cannot be issued against Storage VM (SVM) management LIFs.
| ONTAPI attribute | REST attribute | Comment |
|---|---|---|
ipspace |
name |
net-ipspaces-get-iter
GET /api/network/ipspaces
Usage: This ONTAPI call cannot be issued against Storage VM (SVM) management LIFs.
| ONTAPI attribute | REST attribute | Comment |
|---|---|---|
broadcast-domains |
No REST Equivalent |
A list of broadcast domains can be retrieved by sending a GET request to the /api/network/ethernet/broadcast-domains?ipspace.name={ipspace} endpoint. |
id |
No REST Equivalent |
|
ipspace |
name |
|
ports |
No REST Equivalent |
A list of ports can be retrieved by sending a GET request to the /api/network/ethernet/ports?broadcast_domain.ipspace.name={ipspace} endpoint. |
uuid |
uuid |
|
vservers |
No REST Equivalent |
A list of SVMs can be retrieved by sending a GET request to the /api/svm/svms?ipspace.name={ipspace} endpoint. |
max-records |
max_records |
Specifies the maximum number of records to return before paging. |
net-ipspaces-rename
PATCH /api/network/ipspaces/{uuid}
Usage: This ONTAPI call cannot be issued against Storage VM (SVM) management LIFs.
| ONTAPI attribute | REST attribute | Comment |
|---|---|---|
ipspace |
No REST Equivalent |
|
new-name |
name |
net-ndp-active-neighbor-destroy
This ONTAPI call does not have an equivalent REST API call.
net-ndp-active-neighbor-get
This ONTAPI call does not have an equivalent REST API call.
net-ndp-active-neighbor-get-iter
This ONTAPI call does not have an equivalent REST API call.
net-ndp-default-router-delete-all
This ONTAPI call does not have an equivalent REST API call.
net-ndp-default-router-get
This ONTAPI call does not have an equivalent REST API call.
net-ndp-default-router-get-iter
This ONTAPI call does not have an equivalent REST API call.
net-ndp-neighbor-create
This ONTAPI call does not have an equivalent REST API call.
net-ndp-neighbor-destroy
This ONTAPI call does not have an equivalent REST API call.
net-ndp-neighbor-get
This ONTAPI call does not have an equivalent REST API call.
net-ndp-neighbor-get-iter
This ONTAPI call does not have an equivalent REST API call.
net-ndp-prefix-delete-all
This ONTAPI call does not have an equivalent REST API call.
net-ndp-prefix-get
This ONTAPI call does not have an equivalent REST API call.
net-ndp-prefix-get-iter
This ONTAPI call does not have an equivalent REST API call.
net-options-get
This ONTAPI call does not have an equivalent REST API call.
net-options-hypervisor-uplink-monitoring-get
This ONTAPI call does not have an equivalent REST API call.
net-options-hypervisor-uplink-monitoring-modify
This ONTAPI call does not have an equivalent REST API call.
net-options-modify
This ONTAPI call does not have an equivalent REST API call.
net-placement-cache-delete
This ONTAPI call does not have an equivalent REST API call.
net-placement-cache-get-iter
This ONTAPI call does not have an equivalent REST API call.
net-placement-discover
This ONTAPI call does not have an equivalent REST API call.
net-port-broadcast-domain-add-ports
PATCH /api/network/ethernet/ports/{uuid}
Usage: This ONTAPI call cannot be issued against Storage VM (SVM) management LIFs.
| ONTAPI attribute | REST attribute | Comment |
|---|---|---|
broadcast-domain |
broadcast_domain.name |
In the REST API, broadcast_domain.uuid also uniquely identifies a broadcast domain. |
ipspace |
broadcast_domain.ipspace.name |
In the REST API, broadcast_domain.uuid also uniquely identifies a broadcast domain. |
ports |
uuid |
In the REST API, the UUID specified in the patch identifies the port to be added to the broadcast domain. |
net-port-broadcast-domain-create
POST /api/network/ethernet/broadcast-domains
Usage: This ONTAPI call cannot be issued against Storage VM (SVM) management LIFs.
| ONTAPI attribute | REST attribute | Comment |
|---|---|---|
broadcast-domain |
name |
|
ipspace |
ipspace.name |
In the REST API, ipspace.uuid also uniquely identifies the IPspace. |
mtu |
mtu |
|
ports |
No REST Equivalent |
In the REST API, you cannot specify ports as part of broadcast-domain POST. To add a port to a broadcast-domain, use /api/network/ethernet/ports/{uuid} PATCH. |
net-port-broadcast-domain-destroy
DELETE /api/network/ethernet/broadcast-domains/{uuid}
Usage: This ONTAPI call cannot be issued against Storage VM (SVM) management LIFs.
| ONTAPI attribute | REST attribute | Comment |
|---|---|---|
broadcast-domain |
uuid |
In the REST API, uuid uniquely identifies the broadcast domain to be deleted. |
ipspace |
uuid |
In the REST API, uuid uniquely identifies the broadcast domain to be deleted. |
net-port-broadcast-domain-get
GET /api/network/ethernet/broadcast-domains/{uuid}
Usage: This ONTAPI call cannot be issued against Storage VM (SVM) management LIFs.
| ONTAPI attribute | REST attribute | Comment |
|---|---|---|
broadcast-domain |
name |
|
failover-groups |
No REST Equivalent |
The common practice will be to use default failover groups, which are all the ports of a broadcast domain. Custom failover groups are not presented in the REST API. |
ipspace |
ipspace.name |
|
is-vip |
No REST Equivalent |
|
mtu |
mtu |
|
port-update-status-combined |
No REST Equivalent |
|
ports |
ports.name |
Also ports.uuid uniquely identifies a port |
subnet-names |
No REST Equivalent |
net-port-broadcast-domain-get-iter
GET /api/network/ethernet/broadcast-domains
Usage: This ONTAPI call cannot be issued against Storage VM (SVM) management LIFs.
| ONTAPI attribute | REST attribute | Comment |
|---|---|---|
broadcast-domain |
name |
|
failover-groups |
No REST Equivalent |
In the REST API, common practice is to use default failover groups, which are all the ports of a broadcast domain. The REST API does not present custom failover groups. |
ipspace |
ipspace.name |
|
is-vip |
No REST Equivalent |
|
mtu |
mtu |
|
port-update-status-combined |
No REST Equivalent |
|
ports |
ports.name |
In the REST API, ports.uuid also uniquely identifies a port. |
subnet-names |
No REST Equivalent |
|
max-records |
max_records |
Specifies the maximum number of records to return before paging. |
net-port-broadcast-domain-merge
This ONTAPI call does not have an equivalent REST API call.
net-port-broadcast-domain-modify
PATCH /api/network/ethernet/broadcast-domains/{uuid}
Usage: This ONTAPI call cannot be issued against Storage VM (SVM) management LIFs.
| ONTAPI attribute | REST attribute | Comment |
|---|---|---|
broadcast-domain |
name |
|
ipspace |
ipspace.name |
In the REST API ipspace.uuid also uniquely identifies the IPspace. |
mtu |
mtu |
net-port-broadcast-domain-remove-ports
PATCH /api/network/ethernet/ports/{uuid}
Usage: This ONTAPI call cannot be issued against Storage VM (SVM) management LIFs.
| ONTAPI attribute | REST attribute | Comment |
|---|---|---|
broadcast-domain |
broadcast_domain.name |
In the REST API, broadcast_domain.uuid also uniquely identifies a broadcast domain. |
ipspace |
broadcast_domain.ipspace.name |
In the REST API, broadcast_domain.uuid also uniquely identifies a broadcast domain. |
ports |
uuid |
In the REST API, uuid specified in the patch identifies the port to be added to the broadcast domain. |
net-port-broadcast-domain-rename
PATCH /api/network/ethernet/broadcast-domains/{uuid}
Usage: This ONTAPI call cannot be issued against Storage VM (SVM) management LIFs.
| ONTAPI attribute | REST attribute | Comment |
|---|---|---|
broadcast-domain |
No REST Equivalent |
|
ipspace |
No REST Equivalent |
|
new-name |
name |
net-port-broadcast-domain-split
This ONTAPI call does not have an equivalent REST API call.
net-port-delete
This ONTAPI call does not have an equivalent REST API call.
net-port-get
GET /api/network/ethernet/ports/{uuid}
Usage: This ONTAPI call can be issued against Storage VM (SVM) management LIFs.
| ONTAPI attribute | REST attribute | Comment |
|---|---|---|
administrative-duplex |
No REST Equivalent |
|
administrative-flowcontrol |
No REST Equivalent |
|
administrative-speed |
No REST Equivalent |
|
autorevert-delay |
No REST Equivalent |
|
broadcast-domain |
broadcast_domain.name |
In the REST API, broadcast_domain.uuid uniquely identifies a broadcast domain. |
health-degraded-reasons |
No REST Equivalent |
|
health-status |
state |
|
ifgrp-distribution-function |
lag.distribution_policy |
|
ifgrp-mode |
lag.mode |
|
ifgrp-node |
No REST Equivalent |
|
ifgrp-port |
name |
|
ignore-health-status |
No REST Equivalent |
|
ipspace |
broadcast_domain.ipspace.name |
|
is-administrative-auto-negotiate |
No REST Equivalent |
|
is-administrative-up |
enabled |
|
is-operational-auto-negotiate |
No REST Equivalent |
|
link-status |
state |
|
mac-address |
mac_address |
|
mtu |
mtu |
|
mtu-admin |
No REST Equivalent |
|
node |
node.name |
|
operational-duplex |
No REST Equivalent |
|
operational-flowcontrol |
No REST Equivalent |
|
operational-speed |
speed |
|
port |
name |
|
port-type |
type |
|
remote-device-id |
No REST Equivalent |
|
role |
No REST Equivalent |
|
vlan-id |
vlan.tag |
|
vlan-node |
vlan.base_port.node.name |
|
vlan-port |
vlan.base_port.name |
|
vm-network-name |
No REST Equivalent |
net-port-get-iter
GET /api/network/ethernet/ports
Usage: This ONTAPI call can be issued against Storage VM (SVM) management LIFs.
| ONTAPI attribute | REST attribute | Comment |
|---|---|---|
administrative-duplex |
No REST Equivalent |
|
administrative-flowcontrol |
No REST Equivalent |
|
administrative-speed |
No REST Equivalent |
|
autorevert-delay |
No REST Equivalent |
|
broadcast-domain |
broadcast_domain.name |
In the REST API, broadcast_domain.uuid uniquely identifies a broadcast domain. |
health-degraded-reasons |
No REST Equivalent |
|
health-status |
state |
|
ifgrp-distribution-function |
lag.distribution_policy |
|
ifgrp-mode |
lag.mode |
|
ifgrp-node |
No REST Equivalent |
|
ifgrp-port |
name |
|
ignore-health-status |
No REST Equivalent |
|
ipspace |
broadcast_domain.ipspace.name |
|
is-administrative-auto-negotiate |
No REST Equivalent |
|
is-administrative-up |
enabled |
|
is-operational-auto-negotiate |
No REST Equivalent |
|
link-status |
state |
|
mac-address |
mac_address |
|
mtu |
mtu |
|
mtu-admin |
No REST Equivalent |
|
node |
node.name |
|
operational-duplex |
No REST Equivalent |
|
operational-flowcontrol |
No REST Equivalent |
|
operational-speed |
speed |
|
port |
name |
|
port-type |
type |
|
remote-device-id |
No REST Equivalent |
|
role |
No REST Equivalent |
|
vlan-id |
vlan.tag |
|
vlan-node |
vlan.base_port.node.name |
|
vlan-port |
vlan.base_port.name |
|
vm-network-name |
No REST Equivalent |
|
max-records |
max_records |
Specifies the maximum number of records to return before paging. |
net-port-health-monitor-disable
This ONTAPI call does not have an equivalent REST API call.
net-port-health-monitor-enable
This ONTAPI call does not have an equivalent REST API call.
net-port-health-monitor-get
This ONTAPI call does not have an equivalent REST API call.
net-port-health-monitor-get-iter
This ONTAPI call does not have an equivalent REST API call.
net-port-ifgrp-add-port
PATCH /api/network/ethernet/ports/{uuid}
Usage: This ONTAPI call cannot be issued against Storage VM (SVM) management LIFs.
| ONTAPI attribute | REST attribute | Comment |
|---|---|---|
ifgrp-name |
name |
|
node |
lag.member_ports.node.name |
Alternatively, in the REST API, you can specify "lag.member_ports.uuid". |
port |
lag.member_ports.name |
Alternatively, in the REST API, you can specify "lag.member_ports.uuid". |
skip-broadcast-domain-placement |
No REST Equivalent |
"Set the broadcast_domain property to the desired broadcast domain in PATCH or POST of an ifgrp in /api/network/ethernet/ports in order to skip automatic broadcast domain placement." |
net-port-ifgrp-create
POST /api/network/ethernet/ports
Usage: This ONTAPI call cannot be issued against Storage VM (SVM) management LIFs.
| ONTAPI attribute | REST attribute | Comment |
|---|---|---|
distribution-function |
lag.distribution_policy |
|
ifgrp-name |
name |
|
mode |
lag.mode |
|
node |
node.name |
|
return-record |
return_records |
net-port-ifgrp-destroy
DELETE /api/network/ethernet/ports/{uuid}
Usage: This ONTAPI call cannot be issued against Storage VM (SVM) management LIFs.
| ONTAPI attribute | REST attribute | Comment |
|---|---|---|
ifgrp-name |
No REST Equivalent |
In the REST API, uuid uniquely identifies the port to delete. |
node |
No REST Equivalent |
In the REST API, uuid uniquely identifies the port to delete. |
net-port-ifgrp-get
GET /api/network/ethernet/ports/{uuid}
Usage: This ONTAPI call cannot be issued against Storage VM (SVM) management LIFs.
| ONTAPI attribute | REST attribute | Comment |
|---|---|---|
distribution-function |
lag.distribution_policy |
|
down-ports |
No REST Equivalent |
In the REST API, a combination of lag.member_ports and lag.active_ports yields down-ports. |
ifgrp-name |
name |
|
mac-address |
mac_address |
|
mode |
lag.mode |
|
node |
node.name |
|
port-participation |
Compare the values of lag.active_ports and lag.member_ports to determine whether all, some, or none of the ports are active. |
|
ports |
lag.member_ports |
|
up-ports |
lag.active_ports |
net-port-ifgrp-remove-port
PATCH /api/network/ethernet/ports/{uuid}
Usage: This ONTAPI call cannot be issued against Storage VM (SVM) management LIFs.
| ONTAPI attribute | REST attribute | Comment |
|---|---|---|
ifgrp-name |
No REST Equivalent |
|
node |
No REST Equivalent |
|
port |
lag.member_ports |
net-port-modify
PATCH /api/network/ethernet/ports/{uuid}
Usage: This ONTAPI call cannot be issued against Storage VM (SVM) management LIFs.
| ONTAPI attribute | REST attribute | Comment |
|---|---|---|
administrative-duplex |
No REST Equivalent |
|
administrative-flowcontrol |
No REST Equivalent |
|
administrative-speed |
No REST Equivalent |
|
autorevert-delay |
No REST Equivalent |
|
ignore-health-status |
No REST Equivalent |
|
ipspace |
No REST Equivalent |
|
is-administrative-auto-negotiate |
No REST Equivalent |
|
is-administrative-up |
enabled |
|
mtu |
No REST Equivalent |
|
node |
No REST Equivalent |
In the REST API, uuid uniquely identifies the port to be patched. |
port |
No REST Equivalent |
In the REST API, uuid uniquely identifies the port to be patched. |
role |
No REST Equivalent |
net-port-modify-iter
PATCH /api/network/ethernet/ports/{uuid}
Usage: This ONTAPI call cannot be issued against Storage VM (SVM) management LIFs.
| ONTAPI attribute | REST attribute | Comment |
|---|---|---|
administrative-duplex |
No REST Equivalent |
|
administrative-flowcontrol |
No REST Equivalent |
|
administrative-speed |
No REST Equivalent |
|
autorevert-delay |
No REST Equivalent |
|
broadcast-domain |
broadcast_domain.name |
|
health-degraded-reasons |
No REST Equivalent |
|
health-status |
No REST Equivalent |
|
ifgrp-distribution-function |
No REST Equivalent |
|
ifgrp-mode |
No REST Equivalent |
|
ifgrp-node |
No REST Equivalent |
|
ifgrp-port |
name |
|
ignore-health-status |
No REST Equivalent |
|
ipspace |
broadcast_domain.ipspace.name |
|
is-administrative-auto-negotiate |
No REST Equivalent |
|
is-administrative-up |
enabled |
|
is-operational-auto-negotiate |
No REST Equivalent |
|
link-status |
No REST Equivalent |
|
mac-address |
No REST Equivalent |
|
mtu |
No REST Equivalent |
In the REST API, this attribute is set by the broadcast domain. |
mtu-admin |
No REST Equivalent |
|
node |
No REST Equivalent |
|
operational-duplex |
No REST Equivalent |
|
operational-flowcontrol |
No REST Equivalent |
|
operational-speed |
No REST Equivalent |
|
port |
No REST Equivalent |
|
port-type |
No REST Equivalent |
|
remote-device-id |
No REST Equivalent |
|
role |
No REST Equivalent |
|
vlan-id |
No REST Equivalent |
|
vlan-node |
No REST Equivalent |
|
vlan-port |
No REST Equivalent |
|
vm-network-name |
No REST Equivalent |
|
continue-on-failure |
No REST Equivalent |
|
max-failure-count |
No REST Equivalent |
|
max-records |
max_records |
Specifies the maximum number of records to return before paging. |
return-failure-list |
No REST Equivalent |
|
return-success-list |
No REST Equivalent |
net-qos-marking-get-iter
This ONTAPI call does not have an equivalent REST API call.
net-qos-marking-modify
This ONTAPI call does not have an equivalent REST API call.
net-routes-create
POST /api/network/ip/routes
Usage: This ONTAPI call can be issued against Storage VM (SVM) management LIFs.
| ONTAPI attribute | REST attribute | Comment |
|---|---|---|
destination |
destination.address |
|
gateway |
destination.netmask |
|
metric |
metric |
|
return-record |
return_records |
net-routes-destroy
DELETE /api/network/ip/routes/{uuid}
Usage: This ONTAPI call can be issued against Storage VM (SVM) management LIFs.
| ONTAPI attribute | REST attribute | Comment |
|---|---|---|
destination |
No REST Equivalent |
In the REST API, uuid uniquely identifies the route entry to be deleted. |
gateway |
No REST Equivalent |
In the REST API, uuid uniquely identifies the route entry to be deleted. |
net-routes-get
GET /api/network/ip/routes/{uuid}
Usage: This ONTAPI call can be issued against Storage VM (SVM) management LIFs.
| ONTAPI attribute | REST attribute | Comment |
|---|---|---|
address-family |
destination.family |
|
destination |
destination.address |
|
gateway |
gateway |
|
metric |
metric |
|
vserver |
svm.name |
net-routes-get-iter
GET /api/network/ip/routes
Usage: This ONTAPI call can be issued against Storage VM (SVM) management LIFs.
| ONTAPI attribute | REST attribute | Comment |
|---|---|---|
address-family |
destination.family |
|
destination |
destination.address |
|
gateway |
gateway |
|
metric |
metric |
|
vserver |
svm.name |
|
max-records |
max_records |
Specifies the maximum number of records to return before paging. |
net-routes-lifs-get
GET /api/network/ip/routes/{uuid}?fields=interfaces.name
Usage: This ONTAPI call can be issued against Storage VM (SVM) management LIFs.
| ONTAPI attribute | REST attribute | Comment |
|---|---|---|
address-family |
destination.family |
|
destination |
destination.address |
|
gateway |
gateway |
|
lif-names |
interfaces.name |
|
vserver |
svm.name |
net-routes-lifs-get-iter
GET /api/network/ip/routes?fields=interfaces.name
Usage: This ONTAPI call can be issued against Storage VM (SVM) management LIFs.
| ONTAPI attribute | REST attribute | Comment |
|---|---|---|
address-family |
destination.family |
|
destination |
destination.address |
|
gateway |
gateway |
|
lif-names |
interfaces.name |
|
vserver |
svm.name |
|
max-records |
max_records |
Specifies the maximum number of records to return before paging. |
net-san-lif-placement-get
GET /api/network/fc/interfaces
Note: Placement for Fibre Channel interfaces is implemented as a GET on REST
endpoint /api/network/fc/interfaces using the "recommend" family of
query parameters.
Placement for SAN IP interfaces is not available in REST.
Usage: This ONTAPI call cannot be issued against Storage VM (SVM) management LIFs.
| ONTAPI attribute | REST attribute | Comment |
|---|---|---|
adapter-type |
No REST Equivalent |
|
broadcast-domain |
No REST Equivalent |
|
ipspace-name |
No REST Equivalent |
|
lifs-per-node |
Query parameter "recommend.interfaces_per_node". |
|
nodelist |
Query parameter "recommend.nodes.name" or "recommend.nodes.uuid". |
|
protocol |
Query parameter "recommend.data_protocol". |
|
subnet-name |
No REST Equivalent |
net-subnet-add-ranges
PATCH /api/network/ip/subnets/{uuid}
Usage: This ONTAPI call cannot be issued against Storage VM (SVM) management LIFs.
| ONTAPI attribute | REST attribute | Comment |
|---|---|---|
force-update-lif-associations |
fail_if_lifs_conflict |
The mapped fields are opposite in behavior i.e. setting force-update-lif-associations to TRUE is equivalent to setting fail_if_lifs_conflict to FALSE and vice versa. |
ip-ranges |
ip_ranges.* |
ip_ranges.start and ip_ranges.end |
ipspace |
ipspace.name |
The parameter ipspace.uuid can also be used to uniquely identify the IPspace. |
subnet-name |
name |
net-subnet-create
POST /api/network/ip/subnets
Usage: This ONTAPI call cannot be issued against Storage VM (SVM) management LIFs.
| ONTAPI attribute | REST attribute | Comment |
|---|---|---|
broadcast-domain |
broadcast_domain.name |
The parameter broadcast_domain.uuid can also be used to uniquely identify the broadcast domain. |
force-update-lif-associations |
fail_if_lifs_conflict |
The mapped fields are opposite in behavior i.e. setting force-update-lif-associations to TRUE is equivalent to setting fail_if_lifs_conflict to FALSE and vice versa. |
gateway |
gateway |
|
ip-ranges |
ip_ranges.* |
ip_ranges.start and ip_ranges.end |
ipspace |
ipspace.name |
The parameter ipspace.uuid can also be used to uniquely identify the IPspace. |
return-record |
return_records |
|
subnet |
subnet.* |
subnet.address and subnet.netmask |
subnet-name |
name |
net-subnet-destroy
DELETE /api/network/ip/subnets/{uuid}
Usage: This ONTAPI call cannot be issued against Storage VM (SVM) management LIFs.
| ONTAPI attribute | REST attribute | Comment |
|---|---|---|
force-update-lif-associations |
No REST Equivalent |
|
ipspace |
No REST Equivalent |
|
subnet-name |
No REST Equivalent |
net-subnet-get
GET /api/network/ip/subnets/{uuid}
Usage: This ONTAPI call cannot be issued against Storage VM (SVM) management LIFs.
| ONTAPI attribute | REST attribute | Comment |
|---|---|---|
available-count |
available_count |
|
broadcast-domain |
broadcast_domain.name |
The parameter broadcast_domain.uuid can also be used to uniquely identify the broadcast domain. |
force-update-lif-associations |
No REST Equivalent |
|
gateway |
gateway |
|
ip-ranges |
ip_ranges.* |
ip_ranges.start and ip_ranges.end |
ipspace |
ipspace.* |
ipspace.uuid and ipspace.name |
subnet |
subnet.* |
subnet.address, subnet.netmask and subnet.family |
subnet-name |
name |
|
total-count |
total_count |
|
used-count |
used_count |
net-subnet-get-iter
GET /api/network/ip/subnets
Usage: This ONTAPI call cannot be issued against Storage VM (SVM) management LIFs.
| ONTAPI attribute | REST attribute | Comment |
|---|---|---|
available-count |
available_count |
|
broadcast-domain |
broadcast_domain.name |
The parameter broadcast_domain.uuid can also be used to uniquely identify the broadcast domain. |
force-update-lif-associations |
No REST Equivalent |
|
gateway |
gateway |
|
ip-ranges |
ip_ranges.* |
ip_ranges.start and ip_ranges.end |
ipspace |
ipspace.* |
ipspace.uuid and ipspace.name |
subnet |
subnet.* |
subnet.address, subnet.netmask * subnet.family |
subnet-name |
name |
|
total-count |
total_count |
|
used-count |
used_count |
|
max-records |
max_records |
net-subnet-modify
PATCH /api/network/ip/subnets/{uuid}
Usage: This ONTAPI call cannot be issued against Storage VM (SVM) management LIFs.
| ONTAPI attribute | REST attribute | Comment |
|---|---|---|
force-update-lif-associations |
fail_if_lifs_conflict |
The mapped fields are opposite in behavior i.e. setting force-update-lif-associations to TRUE is equivalent to setting fail_if_lifs_conflict to FALSE and vice versa. |
gateway |
gateway |
|
ip-ranges |
ip_ranges.* |
ip_ranges.start and ip_ranges.end |
ipspace |
ipspace.* |
ipspace.uuid and ipspace.name |
subnet |
subnet.* |
subnet.address, subnet.netmask and subnet.family |
subnet-name |
name |
net-subnet-remove-ranges
PATCH /api/network/ip/subnets/{uuid}
Usage: This ONTAPI call cannot be issued against Storage VM (SVM) management LIFs.
| ONTAPI attribute | REST attribute | Comment |
|---|---|---|
force-update-lif-associations |
fail_if_lifs_conflict |
The mapped fields are opposite in behavior i.e. setting force-update-lif-associations to TRUE is equivalent to setting fail_if_lifs_conflict to FALSE and vice versa. |
ip-ranges |
ip_ranges.* |
ip_ranges.start and ip_ranges.end |
ipspace |
ipspace.* |
ipspace.uuid and ipspace.name |
subnet-name |
name |
net-subnet-rename
PATCH /api/network/ip/subnets/{uuid}
Usage: This ONTAPI call cannot be issued against Storage VM (SVM) management LIFs.
| ONTAPI attribute | REST attribute | Comment |
|---|---|---|
ipspace |
ipspace.* |
ipspace.uuid and ipspace.name |
new-name |
name |
|
subnet-name |
No REST Equivalent |
net-subnets-for-broadcast-domain-get
This ONTAPI call does not have an equivalent REST API call.
net-subnets-for-broadcast-domain-get-iter
This ONTAPI call does not have an equivalent REST API call.
net-test-path
This ONTAPI call does not have an equivalent REST API call.
net-traceroute6
This ONTAPI call does not have an equivalent REST API call.
net-tuning-icmp-get
This ONTAPI call does not have an equivalent REST API call.
net-tuning-icmp-modify
This ONTAPI call does not have an equivalent REST API call.
net-tuning-icmp6-get
This ONTAPI call does not have an equivalent REST API call.
net-tuning-icmp6-modify
This ONTAPI call does not have an equivalent REST API call.
net-tuning-tcp-get
This ONTAPI call does not have an equivalent REST API call.
net-tuning-tcp-modify
This ONTAPI call does not have an equivalent REST API call.
net-vip-port-create
This ONTAPI call does not have an equivalent REST API call.
net-vip-port-destroy
This ONTAPI call does not have an equivalent REST API call.
net-vip-port-get
This ONTAPI call does not have an equivalent REST API call.
net-vip-port-get-iter
This ONTAPI call does not have an equivalent REST API call.
net-vlan-create
POST /api/network/ethernet/ports
Usage: This ONTAPI call cannot be issued against Storage VM (SVM) management LIFs.
| ONTAPI attribute | REST attribute | Comment |
|---|---|---|
gvrp-enabled |
No REST Equivalent |
|
interface-name |
name |
|
node |
node.name |
|
parent-interface |
vlan.base_port |
|
skip-broadcast-domain-placement |
No REST Equivalent |
"Set the broadcast_domain property to the desired broadcast domain in order to skip automatic broadcast domain placement." |
vlanid |
vlan.tag |
net-vlan-delete
DELETE /api/network/ethernet/ports/{uuid}
Usage: This ONTAPI call cannot be issued against Storage VM (SVM) management LIFs.
| ONTAPI attribute | REST attribute | Comment |
|---|---|---|
vlan-info |
No REST Equivalent |
In the REST API, uuid uniquely identifies the VLAN port to be deleted. |
net-vlan-get
GET /api/network/ethernet/ports/{uuid}
Usage: This ONTAPI call cannot be issued against Storage VM (SVM) management LIFs.
| ONTAPI attribute | REST attribute | Comment |
|---|---|---|
gvrp-enabled |
No REST Equivalent |
|
interface-name |
name |
|
node |
node.name |
|
parent-interface |
vlan.base_port |
|
skip-broadcast-domain-placement |
No REST Equivalent |
|
vlanid |
vlan.tag |
net-vlan-get-iter
GET /api/network/ethernet/ports
Usage: This ONTAPI call cannot be issued against Storage VM (SVM) management LIFs.
| ONTAPI attribute | REST attribute | Comment |
|---|---|---|
gvrp-enabled |
No REST Equivalent |
|
interface-name |
name |
|
node |
node.name |
|
parent-interface |
vlan.base_port |
|
skip-broadcast-domain-placement |
No REST Equivalent |
|
vlanid |
vlan.tag |
|
max-records |
max_records |
Specifies the maximum number of records to return before paging. |