Skip to end of metadata
Go to start of metadata

REST API Method: POST /rest/sbaconfig

Modifies the SBA configuration resource. This is the first step in setting up the SBA.

Status of the SBA configuration request must be also checked by querying the SBA Action Status Resource .

URL:

https://192.168.0.111/rest/sbaconfig

HTTP Method

POST

Requires Authentication:

true

Parameters

Parameter Name Required Service Affecting Data Type Default Value Possible Values Description
DHCPEnabledNoYesEnum1Possible values:
  • 0 - btFalse
  • 1 - btTrue
Enables Dynamic Host Configuration Protocol (DHCP) for network configuration. If DHCP is enabled, it overrides the IP address and DNS settings.
ipv4AddressNoYesstringnone16 - Max Length Specifies a manually configured IPv4 address for this ethernet port, when DHCP is not enabled.
ipv4NetmaskNoYesstringnone16 - Max Length Specifies the netmask for a manually configured IPv4 address on this ethernet port, when DHCP is not enabled.
ipv4GatewayNoYesstringnone16 - Max Length Specifies the default gateway for a manually configured IPv4 address on this ethernet port, when DHCP is not enabled.
RemoteDesktopEnabledNoNoEnum0Possible values:
  • 0 - btFalse
  • 1 - btTrue
Enables Remote Desktop for direct console login. This function is intended for administrator use only.
DNSServer1NoYesstringnone64 - Max Length Specifies a manually configured Domain Name Server address for IP name resolution. This server is used first for DNS requests. Applicable when DHCP is not enabled.
DNSServer2NoYesstringnone64 - Max Length Specifies a manually configured Domain Name Server address for IP name resolution. This server is used when the Preferred DNS server is slow or unreachable. Applicable when DHCP is not enabled.
AclEnableNoYesEnum1Possible values:
  • 0 - btFalse
  • 1 - btTrue
Enables the ASM Windows firewall.
ipv6AddressNoYesstringnone45 - Max Length Specifies a manually configured IPv6 address for this ethernet port.
ipv6PrefixLenNoYesint64Possible values:
  • 0 - Minimum
  • 128 - Maximum
Specifies the netmask prefix length for a manually configured IPv6 address on this ethernet port.
ipv6GatewayNoYesstringnone45 - Max Length Specifies the default gateway for a manually configured IPv6 address on this ethernet port.
Eth2ipv4DHCPEnabledNoYesEnum1Possible values:
  • 0 - btFalse
  • 1 - btTrue
Enables Dynamic Host Configuration Protocol (DHCP) for ASM Port 2 network configuration. If DHCP is enabled, it overrides the IP address and DNS settings.
Eth2ipv4AddressNoYesstringnone16 - Max Length Specifies a manually configured IPv4 address for the ASM Port 2, when DHCP is not enabled.
Eth2ipv4NetmaskNoYesstringnone16 - Max Length Specifies the netmask for a manually configured IPv4 address on the ASM Port 2, when DHCP is not enabled.
Eth2DNSServer1NoYesstringnone64 - Max Length Specifies a manually configured Domain Name Server address for IP name resolution. This server is used first for DNS requests. Applicable when DHCP is not enabled.
Eth2DNSServer2NoYesstringnone64 - Max Length Specifies a manually configured Domain Name Server address for IP name resolution. This server is used when the Preferred DNS server is slow or unreachable. Applicable when DHCP is not enabled.
Eth2ipv6AddressNoYesstringnone45 - Max Length Specifies a manually configured IPv6 address on the ASM Port 2.
Eth2ipv6PrefixLenNoYesint64Possible values:
  • 0 - Minimum
  • 128 - Maximum
Specifies the netmask prefix length for a manually configured IPv6 address on the ASM Port 2.
Eth2ipv4GatewayNoYesstringnone16 - Max Length Specifies the default gateway for a manually configured IPv4 address on the ASM Port 2, when DHCP is not enabled.
Eth2ipv6GatewayNoYesstringnone45 - Max Length Specifies the default gateway for a manually configured IPv6 address on the ASM Port 2.
ProxyEnabledNoYesEnum0Possible values:
  • 0 - btFalse
  • 1 - btTrue
Enables Proxy for network configuration.
ProxyAddressNoYesstringnone45 - Max Length Specifies a proxy address.
ProxyPortNoNoint1 Specifies a proxy port.

Helpful Tip

The POST can contain either only the attributes that are being updated, or the full set of attributes for the resource

  • No labels