![]() |
![]() |
![]() |
libnm Reference Manual | ![]() |
---|---|---|---|---|
Top | Description | Object Hierarchy | Properties |
NMSettingIPConfigNMSettingIPConfig — Abstract base class for IPv4 and IPv6 addressing, routing, and name service properties |
#include <nm-setting-ip-config.h> typedef NMIPAddress; NMIPAddress * nm_ip_address_new (int family
,const char *addr
,guint prefix
,GError **error
); NMIPAddress * nm_ip_address_new_binary (int family
,gconstpointer addr
,guint prefix
,GError **error
); void nm_ip_address_ref (NMIPAddress *address
); void nm_ip_address_unref (NMIPAddress *address
); gboolean nm_ip_address_equal (NMIPAddress *address
,NMIPAddress *other
); NMIPAddress * nm_ip_address_dup (NMIPAddress *address
); int nm_ip_address_get_family (NMIPAddress *address
); const char * nm_ip_address_get_address (NMIPAddress *address
); void nm_ip_address_set_address (NMIPAddress *address
,const char *addr
); void nm_ip_address_get_address_binary (NMIPAddress *address
,gpointer addr
); void nm_ip_address_set_address_binary (NMIPAddress *address
,gconstpointer addr
); guint nm_ip_address_get_prefix (NMIPAddress *address
); void nm_ip_address_set_prefix (NMIPAddress *address
,guint prefix
); char ** nm_ip_address_get_attribute_names (NMIPAddress *address
); GVariant * nm_ip_address_get_attribute (NMIPAddress *address
,const char *name
); void nm_ip_address_set_attribute (NMIPAddress *address
,const char *name
,GVariant *value
); typedef NMIPRoute; NMIPRoute * nm_ip_route_new (int family
,const char *dest
,guint prefix
,const char *next_hop
,gint64 metric
,GError **error
); NMIPRoute * nm_ip_route_new_binary (int family
,gconstpointer dest
,guint prefix
,gconstpointer next_hop
,gint64 metric
,GError **error
); void nm_ip_route_ref (NMIPRoute *route
); void nm_ip_route_unref (NMIPRoute *route
); gboolean nm_ip_route_equal (NMIPRoute *route
,NMIPRoute *other
); NMIPRoute * nm_ip_route_dup (NMIPRoute *route
); int nm_ip_route_get_family (NMIPRoute *route
); const char * nm_ip_route_get_dest (NMIPRoute *route
); void nm_ip_route_set_dest (NMIPRoute *route
,const char *dest
); void nm_ip_route_get_dest_binary (NMIPRoute *route
,gpointer dest
); void nm_ip_route_set_dest_binary (NMIPRoute *route
,gconstpointer dest
); guint nm_ip_route_get_prefix (NMIPRoute *route
); void nm_ip_route_set_prefix (NMIPRoute *route
,guint prefix
); const char * nm_ip_route_get_next_hop (NMIPRoute *route
); void nm_ip_route_set_next_hop (NMIPRoute *route
,const char *next_hop
); gboolean nm_ip_route_get_next_hop_binary (NMIPRoute *route
,gpointer next_hop
); void nm_ip_route_set_next_hop_binary (NMIPRoute *route
,gconstpointer next_hop
); gint64 nm_ip_route_get_metric (NMIPRoute *route
); void nm_ip_route_set_metric (NMIPRoute *route
,gint64 metric
); char ** nm_ip_route_get_attribute_names (NMIPRoute *route
); GVariant * nm_ip_route_get_attribute (NMIPRoute *route
,const char *name
); void nm_ip_route_set_attribute (NMIPRoute *route
,const char *name
,GVariant *value
); #define NM_SETTING_IP_CONFIG_METHOD #define NM_SETTING_IP_CONFIG_DNS #define NM_SETTING_IP_CONFIG_DNS_SEARCH #define NM_SETTING_IP_CONFIG_ADDRESSES #define NM_SETTING_IP_CONFIG_GATEWAY #define NM_SETTING_IP_CONFIG_ROUTES #define NM_SETTING_IP_CONFIG_ROUTE_METRIC #define NM_SETTING_IP_CONFIG_IGNORE_AUTO_ROUTES #define NM_SETTING_IP_CONFIG_IGNORE_AUTO_DNS #define NM_SETTING_IP_CONFIG_DHCP_HOSTNAME #define NM_SETTING_IP_CONFIG_DHCP_SEND_HOSTNAME #define NM_SETTING_IP_CONFIG_NEVER_DEFAULT #define NM_SETTING_IP_CONFIG_MAY_FAIL struct NMSettingIPConfig; NMSettingIPConfigClass; const char * nm_setting_ip_config_get_method (NMSettingIPConfig *setting
); guint nm_setting_ip_config_get_num_dns (NMSettingIPConfig *setting
); const char * nm_setting_ip_config_get_dns (NMSettingIPConfig *setting
,int i
); gboolean nm_setting_ip_config_add_dns (NMSettingIPConfig *setting
,const char *dns
); void nm_setting_ip_config_remove_dns (NMSettingIPConfig *setting
,int i
); gboolean nm_setting_ip_config_remove_dns_by_value (NMSettingIPConfig *setting
,const char *dns
); void nm_setting_ip_config_clear_dns (NMSettingIPConfig *setting
); guint nm_setting_ip_config_get_num_dns_searches (NMSettingIPConfig *setting
); const char * nm_setting_ip_config_get_dns_search (NMSettingIPConfig *setting
,int i
); gboolean nm_setting_ip_config_add_dns_search (NMSettingIPConfig *setting
,const char *dns_search
); void nm_setting_ip_config_remove_dns_search (NMSettingIPConfig *setting
,int i
); gboolean nm_setting_ip_config_remove_dns_search_by_value (NMSettingIPConfig *setting
,const char *dns_search
); void nm_setting_ip_config_clear_dns_searches (NMSettingIPConfig *setting
); guint nm_setting_ip_config_get_num_addresses (NMSettingIPConfig *setting
); NMIPAddress * nm_setting_ip_config_get_address (NMSettingIPConfig *setting
,int i
); gboolean nm_setting_ip_config_add_address (NMSettingIPConfig *setting
,NMIPAddress *address
); void nm_setting_ip_config_remove_address (NMSettingIPConfig *setting
,int i
); gboolean nm_setting_ip_config_remove_address_by_value (NMSettingIPConfig *setting
,NMIPAddress *address
); void nm_setting_ip_config_clear_addresses (NMSettingIPConfig *setting
); const char * nm_setting_ip_config_get_gateway (NMSettingIPConfig *setting
); guint nm_setting_ip_config_get_num_routes (NMSettingIPConfig *setting
); NMIPRoute * nm_setting_ip_config_get_route (NMSettingIPConfig *setting
,int i
); gboolean nm_setting_ip_config_add_route (NMSettingIPConfig *setting
,NMIPRoute *route
); void nm_setting_ip_config_remove_route (NMSettingIPConfig *setting
,int i
); gboolean nm_setting_ip_config_remove_route_by_value (NMSettingIPConfig *setting
,NMIPRoute *route
); void nm_setting_ip_config_clear_routes (NMSettingIPConfig *setting
); gint64 nm_setting_ip_config_get_route_metric (NMSettingIPConfig *setting
); gboolean nm_setting_ip_config_get_ignore_auto_routes (NMSettingIPConfig *setting
); gboolean nm_setting_ip_config_get_ignore_auto_dns (NMSettingIPConfig *setting
); const char * nm_setting_ip_config_get_dhcp_hostname (NMSettingIPConfig *setting
); gboolean nm_setting_ip_config_get_dhcp_send_hostname (NMSettingIPConfig *setting
); gboolean nm_setting_ip_config_get_never_default (NMSettingIPConfig *setting
); gboolean nm_setting_ip_config_get_may_fail (NMSettingIPConfig *setting
);
GBoxed +----NMIPAddress
GBoxed +----NMIPRoute
GObject +----NMSetting +----NMSettingIPConfig +----NMSettingIP4Config +----NMSettingIP6Config
"addresses" GPtrArray* : Read / Write "dhcp-hostname" gchar* : Read / Write "dhcp-send-hostname" gboolean : Read / Write / Construct "dns" GStrv : Read / Write "dns-search" GStrv : Read / Write "gateway" gchar* : Read / Write "ignore-auto-dns" gboolean : Read / Write / Construct "ignore-auto-routes" gboolean : Read / Write / Construct "may-fail" gboolean : Read / Write / Construct "method" gchar* : Read / Write "never-default" gboolean : Read / Write / Construct "route-metric" gint64 : Read / Write / Construct "routes" GPtrArray* : Read / Write
NMSettingIPConfig is the abstract base class of NMSettingIP4Config and NMSettingIP6Config, providing properties related to IP addressing, routing, and Domain Name Service.
NMIPAddress * nm_ip_address_new (int family
,const char *addr
,guint prefix
,GError **error
);
Creates a new NMIPAddress object.
|
the IP address family (AF_INET or AF_INET6 ) |
|
the IP address |
|
the address prefix length |
|
location to store error, or NULL
|
Returns : |
the new NMIPAddress object, or NULL on error. [transfer full]
|
NMIPAddress * nm_ip_address_new_binary (int family
,gconstpointer addr
,guint prefix
,GError **error
);
Creates a new NMIPAddress object. addr
must point to a buffer of the
correct size for family
.
|
the IP address family (AF_INET or AF_INET6 ) |
|
the IP address |
|
the address prefix length |
|
location to store error, or NULL
|
Returns : |
the new NMIPAddress object, or NULL on error. [transfer full]
|
void nm_ip_address_ref (NMIPAddress *address
);
Increases the reference count of the object.
|
the NMIPAddress |
void nm_ip_address_unref (NMIPAddress *address
);
Decreases the reference count of the object. If the reference count reaches zero, the object will be destroyed.
|
the NMIPAddress |
gboolean nm_ip_address_equal (NMIPAddress *address
,NMIPAddress *other
);
Determines if two NMIPAddress objects contain the same address and prefix (attributes are not compared).
|
the NMIPAddress |
|
the NMIPAddress to compare address to. |
Returns : |
TRUE if the objects contain the same values, FALSE if they do not. |
NMIPAddress * nm_ip_address_dup (NMIPAddress *address
);
Creates a copy of address
|
the NMIPAddress |
Returns : |
a copy of address . [transfer full]
|
int nm_ip_address_get_family (NMIPAddress *address
);
Gets the IP address family (eg, AF_INET) property of this address object.
|
the NMIPAddress |
Returns : |
the IP address family |
const char * nm_ip_address_get_address (NMIPAddress *address
);
Gets the IP address property of this address object.
|
the NMIPAddress |
Returns : |
the IP address |
void nm_ip_address_set_address (NMIPAddress *address
,const char *addr
);
Sets the IP address property of this address object.
addr
must be a valid address of address
's family. If you aren't sure you
have a valid address, use nm_utils_ipaddr_valid()
to check it.
|
the NMIPAddress |
|
the IP address, as a string |
void nm_ip_address_get_address_binary (NMIPAddress *address
,gpointer addr
);
Gets the IP address property of this address object.
addr
must point to a buffer that is the correct size for address
's family.
|
the NMIPAddress |
|
a buffer in which to store the address in binary format. |
void nm_ip_address_set_address_binary (NMIPAddress *address
,gconstpointer addr
);
Sets the IP address property of this address object.
addr
must point to a buffer that is the correct size for address
's family.
|
the NMIPAddress |
|
the address, in binary format |
guint nm_ip_address_get_prefix (NMIPAddress *address
);
Gets the IP address prefix (ie "24" or "30" etc) property of this address object.
|
the NMIPAddress |
Returns : |
the IP address prefix |
void nm_ip_address_set_prefix (NMIPAddress *address
,guint prefix
);
Sets the IP address prefix property of this address object.
|
the NMIPAddress |
|
the IP address prefix |
char ** nm_ip_address_get_attribute_names (NMIPAddress *address
);
Gets an array of attribute names defined on address
.
|
the NMIPAddress |
Returns : |
a NULL -terminated array of attribute names,. [transfer full]
|
GVariant * nm_ip_address_get_attribute (NMIPAddress *address
,const char *name
);
Gets the value of the attribute with name name
on address
|
the NMIPAddress |
|
the name of an address attribute |
Returns : |
the value of the attribute with name name on
address , or NULL if address has no such attribute. [transfer none]
|
void nm_ip_address_set_attribute (NMIPAddress *address
,const char *name
,GVariant *value
);
Sets or clears the named attribute on address
to the given value.
|
the NMIPAddress |
|
the name of an address attribute |
|
the value. [transfer none][allow-none] |
NMIPRoute * nm_ip_route_new (int family
,const char *dest
,guint prefix
,const char *next_hop
,gint64 metric
,GError **error
);
Creates a new NMIPRoute object.
|
the IP address family (AF_INET or AF_INET6 ) |
|
the IP address of the route's destination |
|
the address prefix length |
|
the IP address of the next hop (or NULL ). [allow-none]
|
|
the route metric (or -1 for "default") |
|
location to store error, or NULL
|
Returns : |
the new NMIPRoute object, or NULL on error. [transfer full]
|
NMIPRoute * nm_ip_route_new_binary (int family
,gconstpointer dest
,guint prefix
,gconstpointer next_hop
,gint64 metric
,GError **error
);
Creates a new NMIPRoute object. dest
and next_hop
(if non-NULL
) must
point to buffers of the correct size for family
.
|
the IP address family (AF_INET or AF_INET6 ) |
|
the IP address of the route's destination |
|
the address prefix length |
|
the IP address of the next hop (or NULL ). [allow-none]
|
|
the route metric (or -1 for "default") |
|
location to store error, or NULL
|
Returns : |
the new NMIPRoute object, or NULL on error. [transfer full]
|
void nm_ip_route_ref (NMIPRoute *route
);
Increases the reference count of the object.
|
the NMIPRoute |
void nm_ip_route_unref (NMIPRoute *route
);
Decreases the reference count of the object. If the reference count reaches zero, the object will be destroyed.
|
the NMIPRoute |
gboolean nm_ip_route_equal (NMIPRoute *route
,NMIPRoute *other
);
Determines if two NMIPRoute objects contain the same destination, prefix, next hop, and metric. (Attributes are not compared.)
NMIPRoute * nm_ip_route_dup (NMIPRoute *route
);
Creates a copy of route
|
the NMIPRoute |
Returns : |
a copy of route . [transfer full]
|
int nm_ip_route_get_family (NMIPRoute *route
);
Gets the IP address family (eg, AF_INET) property of this route object.
|
the NMIPRoute |
Returns : |
the IP address family |
const char * nm_ip_route_get_dest (NMIPRoute *route
);
Gets the IP destination address property of this route object.
|
the NMIPRoute |
Returns : |
the IP address of the route's destination |
void nm_ip_route_set_dest (NMIPRoute *route
,const char *dest
);
Sets the destination property of this route object.
dest
must be a valid address of route
's family. If you aren't sure you
have a valid address, use nm_utils_ipaddr_valid()
to check it.
|
the NMIPRoute |
|
the route's destination, as a string |
void nm_ip_route_get_dest_binary (NMIPRoute *route
,gpointer dest
);
Gets the destination property of this route object.
dest
must point to a buffer that is the correct size for route
's family.
|
the NMIPRoute |
|
a buffer in which to store the destination in binary format. |
void nm_ip_route_set_dest_binary (NMIPRoute *route
,gconstpointer dest
);
Sets the destination property of this route object.
dest
must point to a buffer that is the correct size for route
's family.
|
the NMIPRoute |
|
the route's destination, in binary format |
guint nm_ip_route_get_prefix (NMIPRoute *route
);
Gets the IP prefix (ie "24" or "30" etc) of this route.
|
the NMIPRoute |
Returns : |
the IP prefix |
void nm_ip_route_set_prefix (NMIPRoute *route
,guint prefix
);
Sets the prefix property of this route object.
|
the NMIPRoute |
|
the route prefix |
const char * nm_ip_route_get_next_hop (NMIPRoute *route
);
Gets the IP address of the next hop of this route; this will be NULL
if the
route has no next hop.
void nm_ip_route_set_next_hop (NMIPRoute *route
,const char *next_hop
);
Sets the next-hop property of this route object.
next_hop
(if non-NULL
) must be a valid address of route
's family. If you
aren't sure you have a valid address, use nm_utils_ipaddr_valid()
to check
it.
|
the NMIPRoute |
|
the route's next hop, as a string. [allow-none] |
gboolean nm_ip_route_get_next_hop_binary (NMIPRoute *route
,gpointer next_hop
);
Gets the next hop property of this route object.
next_hop
must point to a buffer that is the correct size for route
's family.
void nm_ip_route_set_next_hop_binary (NMIPRoute *route
,gconstpointer next_hop
);
Sets the destination property of this route object.
next_hop
(if non-NULL
) must point to a buffer that is the correct size for
route
's family.
|
the NMIPRoute |
|
the route's next hop, in binary format |
gint64 nm_ip_route_get_metric (NMIPRoute *route
);
Gets the route metric property of this route object; lower values indicate "better" or more preferred routes; -1 indicates "default" (meaning NetworkManager will set it appropriately).
|
the NMIPRoute |
Returns : |
the route metric |
void nm_ip_route_set_metric (NMIPRoute *route
,gint64 metric
);
Sets the metric property of this route object.
|
the NMIPRoute |
|
the route metric (or -1 for "default") |
char ** nm_ip_route_get_attribute_names (NMIPRoute *route
);
Gets an array of attribute names defined on route
.
GVariant * nm_ip_route_get_attribute (NMIPRoute *route
,const char *name
);
Gets the value of the attribute with name name
on route
void nm_ip_route_set_attribute (NMIPRoute *route
,const char *name
,GVariant *value
);
Sets the named attribute on route
to the given value.
|
the NMIPRoute |
|
the name of a route attribute |
|
the value. [transfer none][allow-none] |
#define NM_SETTING_IP_CONFIG_IGNORE_AUTO_ROUTES "ignore-auto-routes"
#define NM_SETTING_IP_CONFIG_DHCP_SEND_HOSTNAME "dhcp-send-hostname"
typedef struct { NMSettingClass parent; /* Padding for future expansion */ gpointer padding[8]; } NMSettingIPConfigClass;
const char * nm_setting_ip_config_get_method (NMSettingIPConfig *setting
);
|
the NMSettingIPConfig |
Returns : |
the "method" property of the setting; see NMSettingIP4Config and NMSettingIP6Config for details of the methods available with each type. |
guint nm_setting_ip_config_get_num_dns (NMSettingIPConfig *setting
);
|
the NMSettingIPConfig |
Returns : |
the number of configured DNS servers |
const char * nm_setting_ip_config_get_dns (NMSettingIPConfig *setting
,int i
);
|
the NMSettingIPConfig |
|
index number of the DNS server to return |
Returns : |
the IP address of the DNS server at index i
|
gboolean nm_setting_ip_config_add_dns (NMSettingIPConfig *setting
,const char *dns
);
Adds a new DNS server to the setting.
|
the NMSettingIPConfig |
|
the IP address of the DNS server to add |
Returns : |
TRUE if the DNS server was added; FALSE if the server was already
known |
void nm_setting_ip_config_remove_dns (NMSettingIPConfig *setting
,int i
);
Removes the DNS server at index i
.
|
the NMSettingIPConfig |
|
index number of the DNS server to remove |
gboolean nm_setting_ip_config_remove_dns_by_value (NMSettingIPConfig *setting
,const char *dns
);
Removes the DNS server dns
.
|
the NMSettingIPConfig |
|
the DNS server to remove |
Returns : |
TRUE if the DNS server was found and removed; FALSE if it was not. |
void nm_setting_ip_config_clear_dns (NMSettingIPConfig *setting
);
Removes all configured DNS servers.
|
the NMSettingIPConfig |
guint nm_setting_ip_config_get_num_dns_searches
(NMSettingIPConfig *setting
);
|
the NMSettingIPConfig |
Returns : |
the number of configured DNS search domains |
const char * nm_setting_ip_config_get_dns_search (NMSettingIPConfig *setting
,int i
);
|
the NMSettingIPConfig |
|
index number of the DNS search domain to return |
Returns : |
the DNS search domain at index i
|
gboolean nm_setting_ip_config_add_dns_search (NMSettingIPConfig *setting
,const char *dns_search
);
Adds a new DNS search domain to the setting.
|
the NMSettingIPConfig |
|
the search domain to add |
Returns : |
TRUE if the DNS search domain was added; FALSE if the search
domain was already known |
void nm_setting_ip_config_remove_dns_search (NMSettingIPConfig *setting
,int i
);
Removes the DNS search domain at index i
.
|
the NMSettingIPConfig |
|
index number of the DNS search domain |
gboolean nm_setting_ip_config_remove_dns_search_by_value (NMSettingIPConfig *setting
,const char *dns_search
);
Removes the DNS search domain dns_search
.
|
the NMSettingIPConfig |
|
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 |
void nm_setting_ip_config_clear_dns_searches
(NMSettingIPConfig *setting
);
Removes all configured DNS search domains.
|
the NMSettingIPConfig |
guint nm_setting_ip_config_get_num_addresses
(NMSettingIPConfig *setting
);
|
the NMSettingIPConfig |
Returns : |
the number of configured addresses |
NMIPAddress * nm_setting_ip_config_get_address (NMSettingIPConfig *setting
,int i
);
|
the NMSettingIPConfig |
|
index number of the address to return |
Returns : |
the address at index i
|
gboolean nm_setting_ip_config_add_address (NMSettingIPConfig *setting
,NMIPAddress *address
);
Adds a new IP address and associated information to the setting. The given address is duplicated internally and is not changed by this function.
|
the NMSettingIPConfig |
|
the new address to add |
Returns : |
TRUE if the address was added; FALSE if the address was already
known. |
void nm_setting_ip_config_remove_address (NMSettingIPConfig *setting
,int i
);
Removes the address at index i
.
|
the NMSettingIPConfig |
|
index number of the address to remove |
gboolean nm_setting_ip_config_remove_address_by_value (NMSettingIPConfig *setting
,NMIPAddress *address
);
Removes the address address
.
|
the NMSettingIPConfig |
|
the IP address to remove |
Returns : |
TRUE if the address was found and removed; FALSE if it was not. |
void nm_setting_ip_config_clear_addresses
(NMSettingIPConfig *setting
);
Removes all configured addresses.
|
the NMSettingIPConfig |
const char * nm_setting_ip_config_get_gateway (NMSettingIPConfig *setting
);
|
the NMSettingIPConfig |
Returns : |
the IP address of the gateway associated with this configuration, or
NULL . |
guint nm_setting_ip_config_get_num_routes (NMSettingIPConfig *setting
);
|
the NMSettingIPConfig |
Returns : |
the number of configured routes |
NMIPRoute * nm_setting_ip_config_get_route (NMSettingIPConfig *setting
,int i
);
|
the NMSettingIPConfig |
|
index number of the route to return |
Returns : |
the route at index i
|
gboolean nm_setting_ip_config_add_route (NMSettingIPConfig *setting
,NMIPRoute *route
);
Adds a new route and associated information to the setting. The given route is duplicated internally and is not changed by this function.
|
the NMSettingIPConfig |
|
the route to add |
Returns : |
TRUE if the route was added; FALSE if the route was already known. |
void nm_setting_ip_config_remove_route (NMSettingIPConfig *setting
,int i
);
Removes the route at index i
.
|
the NMSettingIPConfig |
|
index number of the route |
gboolean nm_setting_ip_config_remove_route_by_value (NMSettingIPConfig *setting
,NMIPRoute *route
);
Removes the route route
.
|
the NMSettingIPConfig |
|
the route to remove |
Returns : |
TRUE if the route was found and removed; FALSE if it was not. |
void nm_setting_ip_config_clear_routes (NMSettingIPConfig *setting
);
Removes all configured routes.
|
the NMSettingIPConfig |
gint64 nm_setting_ip_config_get_route_metric
(NMSettingIPConfig *setting
);
Returns the value contained in the "route-metric" property.
|
the NMSettingIPConfig |
Returns : |
the route metric that is used for routes that don't explicitly specify a metric. See "route-metric" for more details. |
gboolean nm_setting_ip_config_get_ignore_auto_routes
(NMSettingIPConfig *setting
);
Returns the value contained in the "ignore-auto-routes" property.
|
the NMSettingIPConfig |
Returns : |
TRUE if automatically configured (ie via DHCP) routes should be
ignored. |
gboolean nm_setting_ip_config_get_ignore_auto_dns
(NMSettingIPConfig *setting
);
Returns the value contained in the "ignore-auto-dns" property.
|
the NMSettingIPConfig |
Returns : |
TRUE if automatically configured (ie via DHCP) DNS information
should be ignored. |
const char * nm_setting_ip_config_get_dhcp_hostname
(NMSettingIPConfig *setting
);
Returns the value contained in the "dhcp-hostname" property.
|
the NMSettingIPConfig |
Returns : |
the configured hostname to send to the DHCP server |
gboolean nm_setting_ip_config_get_dhcp_send_hostname
(NMSettingIPConfig *setting
);
Returns the value contained in the "dhcp-send-hostname" property.
|
the NMSettingIPConfig |
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. |
gboolean nm_setting_ip_config_get_never_default
(NMSettingIPConfig *setting
);
Returns the value contained in the "never-default" property.
|
the NMSettingIPConfig |
Returns : |
TRUE if this connection should never be the default
connection |
gboolean nm_setting_ip_config_get_may_fail (NMSettingIPConfig *setting
);
Returns the value contained in the "may-fail" property.
|
the NMSettingIPConfig |
Returns : |
TRUE if this connection doesn't require this type of IP
addressing to complete for the connection to succeed. |
"addresses"
property"addresses" GPtrArray* : Read / Write
Array of IP addresses.
Element-Type: NMIPAddress
"dhcp-hostname"
property"dhcp-hostname" gchar* : Read / Write
If the "dhcp-send-hostname" property is TRUE
, then the
specified name will be sent to the DHCP server when acquiring a lease.
Default value: NULL
"dhcp-send-hostname"
property"dhcp-send-hostname" gboolean : Read / Write / Construct
If TRUE
, a hostname is sent to the DHCP server when acquiring a lease.
Some DHCP servers use this hostname to update DNS databases, essentially
providing a static hostname for the computer. If the
"dhcp-hostname" property is NULL
and this property is
TRUE
, the current persistent hostname of the computer is sent.
Default value: TRUE
"gateway"
property"gateway" gchar* : Read / Write
The gateway associated with this configuration. This is only meaningful if "addresses" is also set.
Default value: NULL
"ignore-auto-dns"
property"ignore-auto-dns" gboolean : Read / Write / Construct
When "method" is set to "auto" and this property to
TRUE
, automatically configured nameservers and search domains are
ignored and only nameservers and search domains specified in the
"dns" and "dns-search" properties, if
any, are used.
Default value: FALSE
"ignore-auto-routes"
property"ignore-auto-routes" gboolean : Read / Write / Construct
When "method" is set to "auto" and this property to
TRUE
, automatically configured routes are ignored and only routes
specified in the "routes" property, if any, are used.
Default value: FALSE
"may-fail"
property"may-fail" gboolean : Read / Write / Construct
If TRUE
, allow overall network configuration to proceed even if the
configuration specified by this property times out. Note that at least
one IP configuration must succeed or overall network configuration will
still fail. For example, in IPv6-only networks, setting this property to
TRUE
on the NMSettingIP4Config allows the overall network configuration
to succeed if IPv4 configuration fails but IPv6 configuration completes
successfully.
Default value: TRUE
"method"
property"method" gchar* : Read / Write
IP configuration method.
NMSettingIP4Config and NMSettingIP6Config both support "auto", "manual", and "link-local". See the subclass-specific documentation for other values.
In general, for the "auto" method, properties such as "dns" and "routes" specify information that is added on to the information returned from automatic configuration. The "ignore-auto-routes" and "ignore-auto-dns" properties modify this behavior.
For methods that imply no upstream network, such as "shared" or "link-local", these properties must be empty.
Default value: NULL
"never-default"
property"never-default" gboolean : Read / Write / Construct
If TRUE
, this connection will never be the default connection for this
IP type, meaning it will never be assigned the default route by
NetworkManager.
Default value: FALSE
"route-metric"
property"route-metric" gint64 : Read / Write / Construct
The default metric for routes that don't explicitly specify a metric. The default value -1 means that the metric is choosen automatically based on the device type. The metric applies to dynamic routes, manual (static) routes that don't have an explicit metric setting, address prefix routes, and the default route. Note that for IPv6, the kernel accepts zero (0) but coerces it to 1024 (user default). Hence, setting this property to zero effectively mean setting it to 1024. For IPv4, zero is a regular value for the metric.
Allowed values: [-1,4294967295]
Default value: -1
"routes"
property"routes" GPtrArray* : Read / Write
Array of IP routes.
Element-Type: NMIPRoute