network.configuration.update

Update Network Configuration Service configuration.

Type: object

Call parameters

Type: array
No Additional Items

Tuple Validation

Parameter 1: data

data

Type: object

Network configuration data to update.

No Additional Properties

hostname

Hostname

Type: string

System hostname.

domain

Domain

Type: string

System domain name.

ipv4gateway

Ipv4Gateway

Used instead of the default gateway provided by DHCP.

Any of

• Option 1
• Option 2

Type: const

Must be one of:

• ""

Specific value: ""

Type: string

ipv6gateway

Ipv6Gateway

IPv6 default gateway address.

Any of

• Option 1
• Option 2

Type: const

Must be one of:

• ""

Specific value: ""

Type: string

nameserver1

Nameserver1

Primary DNS server.

Any of

• Option 1
• Option 2

Type: const

Must be one of:

• ""

Specific value: ""

Type: string

nameserver2

Nameserver2

Secondary DNS server.

Any of

• Option 1
• Option 2

Type: const

Must be one of:

• ""

Specific value: ""

Type: string

nameserver3

Nameserver3

Tertiary DNS server.

Any of

• Option 1
• Option 2

Type: const

Must be one of:

• ""

Specific value: ""

Type: string

httpproxy

Httpproxy

Type: string

Must be provided if a proxy is to be used for network operations.

hosts

Hosts

Type: array of string

Static host entries to add to the hosts file.

No Additional Items

Each item of this array must be:

Type: string

domains

Domains

Type: array of string

Additional domain names for DNS search.

No Additional Items

Each item of this array must be:

Type: string

service_announcement

ServiceAnnouncement

Type: object

Determines the broadcast protocols that will be used to advertise the server.

No Additional Properties

netbios

Netbios

Type: boolean

Enable the NetBIOS name server (NBNS) which starts concurrently with the SMB service. SMB clients will only perform NBNS lookups if SMB1 is enabled. NBNS may be required for legacy SMB clients.

mdns

Mdns

Type: boolean

Enable multicast DNS service announcements for enabled services.

wsd

Wsd

Type: boolean

Enable Web Service Discovery support.

activity

NetworkConfigurationActivity

Type: object

Network activity filtering configuration.

No Additional Properties

type Required

Type

Type: enum (of string)

Whether to allow or deny the specified network activities.

Must be one of:

• "ALLOW"
• "DENY"

activities

Activities

Type: array of string Default: []

Array of network activity types to allow or deny.

No Additional Items

Each item of this array must be:

Type: string

hostname_b

Hostname B

Hostname for the second controller in HA configurations or null.

Any of

• Option 1
• Option 2

Type: string

Type: null

hostname_virtual

Hostname Virtual

Virtual hostname for HA configurations or null.

Any of

• Option 1
• Option 2

Type: string

Type: null

Return value

NetworkConfigurationEntry

Type: object

The updated network configuration.

No Additional Properties

id Required

Id

Type: integer

Unique identifier for the network configuration.

hostname Required

Hostname

Type: string

System hostname.

domain Required

Domain

Type: string

System domain name.

ipv4gateway Required

Ipv4Gateway

Used instead of the default gateway provided by DHCP.

Any of

• Option 1
• Option 2

Type: const

Must be one of:

• ""

Specific value: ""

Type: string

ipv6gateway Required

Ipv6Gateway

IPv6 default gateway address.

Any of

• Option 1
• Option 2

Type: const

Must be one of:

• ""

Specific value: ""

Type: string

nameserver1 Required

Nameserver1

Primary DNS server.

Any of

• Option 1
• Option 2

Type: const

Must be one of:

• ""

Specific value: ""

Type: string

nameserver2 Required

Nameserver2

Secondary DNS server.

Any of

• Option 1
• Option 2

Type: const

Must be one of:

• ""

Specific value: ""

Type: string

nameserver3 Required

Nameserver3

Tertiary DNS server.

Any of

• Option 1
• Option 2

Type: const

Must be one of:

• ""

Specific value: ""

Type: string

httpproxy Required

Httpproxy

Type: string

Must be provided if a proxy is to be used for network operations.

hosts Required

Hosts

Type: array of string

Static host entries to add to the hosts file.

No Additional Items

Each item of this array must be:

Type: string

domains Required

Domains

Type: array of string

Additional domain names for DNS search.

No Additional Items

Each item of this array must be:

Type: string

service_announcement Required

ServiceAnnouncement

Type: object

Determines the broadcast protocols that will be used to advertise the server.

No Additional Properties

netbios

Netbios

Type: boolean

Enable the NetBIOS name server (NBNS) which starts concurrently with the SMB service. SMB clients will only perform NBNS lookups if SMB1 is enabled. NBNS may be required for legacy SMB clients.

mdns

Mdns

Type: boolean

Enable multicast DNS service announcements for enabled services.

wsd

Wsd

Type: boolean

Enable Web Service Discovery support.

activity Required

NetworkConfigurationActivity

Type: object

Network activity filtering configuration.

No Additional Properties

type Required

Type

Type: enum (of string)

Whether to allow or deny the specified network activities.

Must be one of:

• "ALLOW"
• "DENY"

activities

Activities

Type: array of string Default: []

Array of network activity types to allow or deny.

No Additional Items

Each item of this array must be:

Type: string

hostname_local Required

Hostname Local

Type: string

Local hostname for this system.

hostname_b

Hostname B

Hostname for the second controller in HA configurations or null.

Any of

• Option 1
• Option 2

Type: string

Type: null

hostname_virtual

Hostname Virtual

Virtual hostname for HA configurations or null.

Any of

• Option 1
• Option 2

Type: string

Type: null

state Required

NetWorkConfigurationState

Type: object

Current network configuration state.

No Additional Properties

ipv4gateway Required

Ipv4Gateway

Current IPv4 default gateway address.

Any of

• Option 1
• Option 2

Type: const

Must be one of:

• ""

Specific value: ""

Type: string

ipv6gateway Required

Ipv6Gateway

Current IPv6 default gateway address.

Any of

• Option 1
• Option 2

Type: const

Must be one of:

• ""

Specific value: ""

Type: string

nameserver1 Required

Nameserver1

Current primary DNS server address.

Any of

• Option 1
• Option 2

Type: const

Must be one of:

• ""

Specific value: ""

Type: string

nameserver2 Required

Nameserver2

Current secondary DNS server address.

Any of

• Option 1
• Option 2

Type: const

Must be one of:

• ""

Specific value: ""

Type: string

nameserver3 Required

Nameserver3

Current tertiary DNS server address.

Any of

• Option 1
• Option 2

Type: const

Must be one of:

• ""

Specific value: ""

Type: string

hosts Required

Hosts

Type: array of string

Current hosts file entries.

No Additional Items

Each item of this array must be:

Type: string

Required roles: NETWORK_GENERAL_WRITE