NMSettingIP4Config: libnm-util Reference Manual

nm_ip4_address_unref ()

void
-nm_ip4_address_unref (NMIP4Address *address);

Decreases the reference count of the object. If the reference count -reaches zero, the object will be destroyed.

Parameters

----- - - - - - -

address

nm_ip4_address_compare ()

gboolean
-nm_ip4_address_compare (NMIP4Address *address,
-                        NMIP4Address *other);

Determines if two NMIP4Address objects contain the same values.

Parameters

----- - - - - - - - - - - - - -

address	the NMIP4Address
other	the NMIP4Address to compare `address` -to.

Returns

TRUE if the objects contain the same values, FALSE if they do not.

nm_ip4_address_get_address ()

guint32
-nm_ip4_address_get_address (NMIP4Address *address);

Gets the IPv4 address property of this address object.

Parameters

----- - - - - - -

address

Returns

the IPv4 address in network byte order

nm_ip4_address_set_address ()

void
-nm_ip4_address_set_address (NMIP4Address *address,
-                            guint32 addr);

Sets the IPv4 address property of this object.

Parameters

----- - - - - - - - - - - - - -

address	the NMIP4Address
addr	the IPv4 address in network byte order

nm_ip4_address_get_prefix ()

guint32
-nm_ip4_address_get_prefix (NMIP4Address *address);

Gets the IPv4 address prefix (ie "24" or "30" etc) property of this address -object.

Parameters

----- - - - - - -

address

Returns

the IPv4 address prefix

nm_ip4_address_set_prefix ()

void
-nm_ip4_address_set_prefix (NMIP4Address *address,
-                           guint32 prefix);

Sets the IPv4 address prefix.

Parameters

----- - - - - - - - - - - - - -

address	the NMIP4Address
prefix	the address prefix, a number between 1 and 32 inclusive

nm_ip4_address_get_gateway ()

guint32
-nm_ip4_address_get_gateway (NMIP4Address *address);

Gets the IPv4 default gateway property of this address object.

Parameters

----- - - - - - -

address

Returns

the IPv4 gateway address in network byte order

nm_ip4_address_set_gateway ()

void
-nm_ip4_address_set_gateway (NMIP4Address *address,
-                            guint32 gateway);

Sets the IPv4 default gateway property of this address object.

Parameters

----- - - - - - - - - - - - - -

address	the NMIP4Address
gateway	the IPv4 default gateway in network byte order

nm_ip4_route_new ()

NMIP4Route *
-nm_ip4_route_new (void);

Creates and returns a new NMIP4Route object.

Returns

the new empty NMIP4Route object.

[transfer full]

nm_ip4_route_dup ()

NMIP4Route *
-nm_ip4_route_dup (NMIP4Route *source);

Copies a given NMIP4Route object and returns the copy.

Parameters

----- - - - - - -

source

the NMIP4Route object to copy

Returns

the copy of the given NMIP4Route copy.

[transfer full]

nm_ip4_route_ref ()

void
-nm_ip4_route_ref (NMIP4Route *route);

Increases the reference count of the object.

Parameters

----- - - - - - -

route

nm_ip4_route_unref ()

void
-nm_ip4_route_unref (NMIP4Route *route);

Decreases the reference count of the object. If the reference count -reaches zero, the object will be destroyed.

Parameters

----- - - - - - -

route

nm_ip4_route_compare ()

gboolean
-nm_ip4_route_compare (NMIP4Route *route,
-                      NMIP4Route *other);

Determines if two NMIP4Route objects contain the same values.

Parameters

----- - - - - - - - - - - - - -

route	the NMIP4Route
other	the NMIP4Route to compare `route` -to.

Returns

TRUE if the objects contain the same values, FALSE if they do not.

nm_ip4_route_get_dest ()

guint32
-nm_ip4_route_get_dest (NMIP4Route *route);

Gets the IPv4 destination address property of this route object.

Parameters

----- - - - - - -

route

Returns

the IPv4 address in network byte order

nm_ip4_route_set_dest ()

void
-nm_ip4_route_set_dest (NMIP4Route *route,
-                       guint32 dest);

Sets the IPv4 destination address property of this route object.

Parameters

----- - - - - - - - - - - - - -

route	the NMIP4Route
dest	the destination address in network byte order

nm_ip4_route_get_prefix ()

guint32
-nm_ip4_route_get_prefix (NMIP4Route *route);

Gets the IPv4 prefix (ie "24" or "30" etc) of this route.

Parameters

----- - - - - - -

route

Returns

the IPv4 prefix

nm_ip4_route_set_prefix ()

void
-nm_ip4_route_set_prefix (NMIP4Route *route,
-                         guint32 prefix);

Sets the IPv4 prefix of this route.

Parameters

----- - - - - - - - - - - - - -

route	the NMIP4Route
prefix	the prefix, a number between 1 and 32 inclusive

nm_ip4_route_get_next_hop ()

guint32
-nm_ip4_route_get_next_hop (NMIP4Route *route);

Gets the IPv4 address of the next hop of this route.

Parameters

----- - - - - - -

route

Returns

the IPv4 address in network byte order

nm_ip4_route_set_next_hop ()

void
-nm_ip4_route_set_next_hop (NMIP4Route *route,
-                           guint32 next_hop);

Sets the IPv4 address of the next hop of this route.

Parameters

----- - - - - - - - - - - - - -

route	the NMIP4Route
next_hop	the IPv4 address of the next hop in network byte order

nm_ip4_route_get_metric ()

guint32
-nm_ip4_route_get_metric (NMIP4Route *route);

Gets the route metric property of this route object; lower values indicate -"better" or more preferred routes.

Parameters

----- - - - - - -

route

Returns

the route metric

nm_ip4_route_set_metric ()

void
-nm_ip4_route_set_metric (NMIP4Route *route,
-                         guint32 metric);

Sets the route metric property of this route object; lower values indicate -"better" or more preferred routes.

Parameters

----- - - - - - - - - - - - - -

route	the NMIP4Route
metric	the route metric

nm_setting_ip4_config_new ()

NMSetting *
-nm_setting_ip4_config_new (void);

Creates a new NMSettingIP4Config object with default values.

Returns

the new empty NMSettingIP4Config object.

[transfer full]

nm_setting_ip4_config_get_method ()

const char *
-nm_setting_ip4_config_get_method (NMSettingIP4Config *setting);

Parameters

----- - - - - - -

setting

Returns

the “method” property of the setting

nm_setting_ip4_config_get_num_dns ()

guint32
-nm_setting_ip4_config_get_num_dns (NMSettingIP4Config *setting);

Parameters

----- - - - - - -

setting

Returns

the number of configured DNS servers

nm_setting_ip4_config_get_dns ()

guint32
-nm_setting_ip4_config_get_dns (NMSettingIP4Config *setting,
-                               guint32 i);

Parameters

----- - - - - - - - - - - - - -

setting	the NMSettingIP4Config
i	index number of the DNS server to return

Returns

the IPv4 address (network byte order) of the DNS server at index -i -

nm_setting_ip4_config_add_dns ()

gboolean
-nm_setting_ip4_config_add_dns (NMSettingIP4Config *setting,
-                               guint32 dns);

Adds a new DNS server to the setting.

Parameters

----- - - - - - - - - - - - - -

setting	the NMSettingIP4Config
dns	the IPv4 address (network byte order) of the DNS server to add

Returns

TRUE if the DNS server was added; FALSE if the server was already -known

nm_setting_ip4_config_remove_dns ()

void
-nm_setting_ip4_config_remove_dns (NMSettingIP4Config *setting,
-                                  guint32 i);

Removes the DNS server at index i -.

Parameters

----- - - - - - - - - - - - - -

setting	the NMSettingIP4Config
i	index number of the DNS server to remove

nm_setting_ip4_config_remove_dns_by_value ()

gboolean
-nm_setting_ip4_config_remove_dns_by_value
-                               (NMSettingIP4Config *setting,
-                                guint32 dns);

Removes the DNS server dns -.

Parameters

----- - - - - - - - - - - - - -

setting	the NMSettingIP4Config
dns	the DNS server to remove

Returns

TRUE if the DNS server was found and removed; FALSE if it was not. -domain was already known

Since: 0.9.10

nm_setting_ip4_config_clear_dns ()

void
-nm_setting_ip4_config_clear_dns (NMSettingIP4Config *setting);

Removes all configured DNS servers.

Parameters

----- - - - - - -

setting

nm_setting_ip4_config_get_num_dns_searches ()

guint32
-nm_setting_ip4_config_get_num_dns_searches
-                               (NMSettingIP4Config *setting);

Parameters

----- - - - - - -

setting

Returns

the number of configured DNS search domains

nm_setting_ip4_config_get_dns_search ()

const char *
-nm_setting_ip4_config_get_dns_search (NMSettingIP4Config *setting,
-                                      guint32 i);

Parameters

----- - - - - - - - - - - - - -

setting	the NMSettingIP4Config
i	index number of the DNS search domain to return

Returns

the DNS search domain at index i -

nm_setting_ip4_config_add_dns_search ()

gboolean
-nm_setting_ip4_config_add_dns_search (NMSettingIP4Config *setting,
-                                      const char *dns_search);

Adds a new DNS search domain to the setting.

Parameters

----- - - - - - - - - - - - - -

setting	the NMSettingIP4Config
dns_search	the search domain to add

Returns

TRUE if the DNS search domain was added; FALSE if the search -domain was already known

nm_setting_ip4_config_remove_dns_search ()

void
-nm_setting_ip4_config_remove_dns_search
-                               (NMSettingIP4Config *setting,
-                                guint32 i);

Removes the DNS search domain at index i -.

Parameters

----- - - - - - - - - - - - - -

setting	the NMSettingIP4Config
i	index number of the DNS search domain

nm_setting_ip4_config_remove_dns_search_by_value ()

gboolean
-nm_setting_ip4_config_remove_dns_search_by_value
-                               (NMSettingIP4Config *setting,
-                                const char *dns_search);

Removes the DNS search domain dns_search -.

Parameters

----- - - - - - - - - - - - - -

setting	the NMSettingIP4Config
dns_search	the search domain to remove

Returns

TRUE if the DNS search domain was found and removed; FALSE if it was not.

Since 0.9.10

nm_setting_ip4_config_clear_dns_searches ()

void
-nm_setting_ip4_config_clear_dns_searches
-                               (NMSettingIP4Config *setting);

Removes all configured DNS search domains.

Parameters

----- - - - - - -

setting

nm_setting_ip4_config_get_num_addresses ()

guint32
-nm_setting_ip4_config_get_num_addresses
-                               (NMSettingIP4Config *setting);

Parameters

----- - - - - - -

setting

Returns

the number of configured addresses

nm_setting_ip4_config_get_address ()

NMIP4Address *
-nm_setting_ip4_config_get_address (NMSettingIP4Config *setting,
-                                   guint32 i);

Parameters

----- - - - - - - - - - - - - -

setting	the NMSettingIP4Config
i	index number of the address to return

Returns

the address at index i -

nm_setting_ip4_config_add_address ()

gboolean
-nm_setting_ip4_config_add_address (NMSettingIP4Config *setting,
-                                   NMIP4Address *address);

Adds a new IPv4 address and associated information to the setting. The -given address is duplicated internally and is not changed by this function.

Parameters

----- - - - - - - - - - - - - -

setting	the NMSettingIP4Config
address	the new address to add

Returns

TRUE if the address was added; FALSE if the address was already -known.

nm_setting_ip4_config_remove_address ()

void
-nm_setting_ip4_config_remove_address (NMSettingIP4Config *setting,
-                                      guint32 i);

Removes the address at index i -.

Parameters

----- - - - - - - - - - - - - -

setting	the NMSettingIP4Config
i	index number of the address to remove

nm_setting_ip4_config_remove_address_by_value ()

gboolean
-nm_setting_ip4_config_remove_address_by_value
-                               (NMSettingIP4Config *setting,
-                                NMIP4Address *address);

Removes the address address -.

Parameters

----- - - - - - - - - - - - - -

setting	the NMSettingIP4Config
address	the IP address to remove

Returns

TRUE if the address was found and removed; FALSE if it was not.

Since: 0.9.10

nm_setting_ip4_config_clear_addresses ()

void
-nm_setting_ip4_config_clear_addresses (NMSettingIP4Config *setting);

Removes all configured addresses.

Parameters

----- - - - - - -

setting

nm_setting_ip4_config_get_num_routes ()

guint32
-nm_setting_ip4_config_get_num_routes (NMSettingIP4Config *setting);

Parameters

----- - - - - - -

setting

Returns

the number of configured routes

nm_setting_ip4_config_get_route ()

NMIP4Route *
-nm_setting_ip4_config_get_route (NMSettingIP4Config *setting,
-                                 guint32 i);

Parameters

----- - - - - - - - - - - - - -

setting	the NMSettingIP4Config
i	index number of the route to return

Returns

the route at index i -

nm_setting_ip4_config_add_route ()

gboolean
-nm_setting_ip4_config_add_route (NMSettingIP4Config *setting,
-                                 NMIP4Route *route);

Adds a new IPv4 route and associated information to the setting. The -given route is duplicated internally and is not changed by this function.

Parameters

----- - - - - - - - - - - - - -

setting	the NMSettingIP4Config
route	the route to add

Returns

TRUE if the route was added; FALSE if the route was already known.

nm_setting_ip4_config_remove_route ()

void
-nm_setting_ip4_config_remove_route (NMSettingIP4Config *setting,
-                                    guint32 i);

Removes the route at index i -.

Parameters

----- - - - - - - - - - - - - -

setting	the NMSettingIP4Config
i	index number of the route

nm_setting_ip4_config_remove_route_by_value ()

gboolean
-nm_setting_ip4_config_remove_route_by_value
-                               (NMSettingIP4Config *setting,
-                                NMIP4Route *route);

Removes the route route -.

Parameters

----- - - - - - - - - - - - - -

setting	the NMSettingIP4Config
route	the route to remove

Returns

TRUE if the route was found and removed; FALSE if it was not.

Since: 0.9.10

nm_setting_ip4_config_clear_routes ()

void
-nm_setting_ip4_config_clear_routes (NMSettingIP4Config *setting);

Removes all configured routes.

Parameters

----- - - - - - -

setting

nm_setting_ip4_config_get_route_metric ()

gint64
-nm_setting_ip4_config_get_route_metric
-                               (NMSettingIP4Config *setting);

Returns the value contained in the “route-metric” -property.

Parameters

----- - - - - - -

setting

Returns

the route metric that is used for IPv4 routes that don't explicitly -specify a metric. See “route-metric” for more details.

Since: 1.0

nm_setting_ip4_config_get_ignore_auto_routes ()

gboolean
-nm_setting_ip4_config_get_ignore_auto_routes
-                               (NMSettingIP4Config *setting);

Returns the value contained in the “ignore-auto-routes” -property.

Parameters

----- - - - - - -

setting

Returns

TRUE if automatically configured (ie via DHCP) routes should be -ignored.

nm_setting_ip4_config_get_ignore_auto_dns ()

gboolean
-nm_setting_ip4_config_get_ignore_auto_dns
-                               (NMSettingIP4Config *setting);

Returns the value contained in the “ignore-auto-dns” -property.

Parameters

----- - - - - - -

setting

Returns

TRUE if automatically configured (ie via DHCP) DNS information -should be ignored.

nm_setting_ip4_config_get_dhcp_client_id ()

const char *
-nm_setting_ip4_config_get_dhcp_client_id
-                               (NMSettingIP4Config *setting);

Returns the value contained in the “dhcp-client-id” -property.

Parameters

----- - - - - - -

setting

Returns

the configured Client ID to send to the DHCP server when requesting -addresses via DHCP.

nm_setting_ip4_config_get_dhcp_send_hostname ()

gboolean
-nm_setting_ip4_config_get_dhcp_send_hostname
-                               (NMSettingIP4Config *setting);

Returns the value contained in the “dhcp-send-hostname” -property.

Parameters

----- - - - - - -

setting

Returns

TRUE if NetworkManager should send the machine hostname to the -DHCP server when requesting addresses to allow the server to automatically -update DNS information for this machine.

nm_setting_ip4_config_get_dhcp_hostname ()

const char *
-nm_setting_ip4_config_get_dhcp_hostname
-                               (NMSettingIP4Config *setting);

Returns the value contained in the “dhcp-hostname” -property.

Parameters

----- - - - - - -

setting

Returns

the configured hostname to send to the DHCP server

nm_setting_ip4_config_get_dhcp_timeout ()

int
-nm_setting_ip4_config_get_dhcp_timeout
-                               (NMSettingIP4Config *setting);

Returns the value contained in the “dhcp-timeout” -property.

Parameters

----- - - - - - -

setting

Returns

The number of seconds after which unfinished DHCP transaction -fails or zero for "default".

nm_setting_ip4_config_get_never_default ()

gboolean
-nm_setting_ip4_config_get_never_default
-                               (NMSettingIP4Config *setting);

Returns the value contained in the “never-default” -property.

Parameters

----- - - - - - -

setting

Returns

TRUE if this connection should never be the default connection -for IPv4 addressing

nm_setting_ip4_config_get_may_fail ()

gboolean
-nm_setting_ip4_config_get_may_fail (NMSettingIP4Config *setting);

Returns the value contained in the “may-fail” -property.

Parameters

----- - - - - - -

setting