SettingIPConfig

---

Object Hierarchy:

Description:

Content:

Constants:

• public const string ADDRESSES
• public const string AUTO_ROUTE_EXT_GW
• public const string DAD_TIMEOUT
• public const int DAD_TIMEOUT_MAX
• public const string DHCP_DSCP
• public const string DHCP_HOSTNAME
• public const string DHCP_HOSTNAME_FLAGS
• public const string DHCP_IAID
• public const string DHCP_REJECT_SERVERS
• public const string DHCP_SEND_HOSTNAME
• public const string DHCP_SEND_HOSTNAME_V2
• public const string DHCP_SEND_RELEASE
• public const string DHCP_TIMEOUT
• public const string DNS
• public const string DNS_OPTIONS
• public const string DNS_PRIORITY
• public const string DNS_SEARCH
• public const string FORWARDING
• public const string GATEWAY
• public const string IGNORE_AUTO_DNS
• public const string IGNORE_AUTO_ROUTES
• public const string MAY_FAIL
• public const string METHOD
• public const string NEVER_DEFAULT
• public const string REPLACE_LOCAL_RULE
• public const string REQUIRED_TIMEOUT
• public const string ROUTED_DNS
• public const string ROUTES
• public const string ROUTE_METRIC
• public const string ROUTE_TABLE
• public const string ROUTING_RULES
• public const string SHARED_DHCP_LEASE_TIME
• public const string SHARED_DHCP_RANGE

Properties:

• public GenericArray<IPAddress> addresses { owned get; set; }
  Array of IP addresses.
• public Ternary auto_route_ext_gw { get; set; }
  VPN connections will default to add the route automatically unless this setting is set to false.
• public int dad_timeout { get; set; }
  Maximum timeout in milliseconds used to check for the presence of duplicate IP addresses on the network.
• public string dhcp_dscp { owned get; set; }
  Specifies the value for the DSCP field (traffic class) of the IP header.
• public string dhcp_hostname { owned get; set; }
  If the dhcp_send_hostname property is true, then the specified name will be sent to the DHCP server when acquiring a lease.
• public uint dhcp_hostname_flags { get; set; }
  Flags for the DHCP hostname and FQDN.
• public string dhcp_iaid { owned get; set; }
  A string containing the "Identity Association Identifier" (IAID) used by the DHCP client.
• public string[] dhcp_reject_servers { owned get; set; }
  Array of servers from which DHCP offers must be rejected.
• public bool dhcp_send_hostname { get; set; }
  Since 1.52 this property is deprecated and is only used as fallback value for dhcp_send_hostname_v2 if it's set to 'default'.
• public int dhcp_send_hostname_v2 { get; set; }
  If true, a hostname is sent to the DHCP server when acquiring a lease.
• public Ternary dhcp_send_release { get; set; }
  Whether the DHCP client will send RELEASE message when bringing the connection down.
• public int dhcp_timeout { get; set; }
  A timeout for a DHCP transaction in seconds.
• public string[] dns { owned get; set; }
  Array of DNS servers.
• public string[] dns_options { owned get; set; }
  Array of DNS options to be added to resolv.
• public int dns_priority { get; set; }
  DNS servers priority.
• public string[] dns_search { owned get; set; }
  List of DNS search domains.
• public int forwarding { get; set; }
  Whether to configure sysctl interface-specific forwarding.
• public string gateway { owned get; set; }
  The gateway associated with this configuration.
• public bool ignore_auto_dns { get; set; }
  When method is set to "auto" and this property to true, automatically configured name servers and search domains are ignored and only name servers and search domains specified in the dns and dns_search properties, if any, are used.
• public bool ignore_auto_routes { get; set; }
  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.
• public bool may_fail { get; set; }
  If true, allow overall network configuration to proceed even if the configuration specified by this property times out.
• public string method { owned get; set; }
  IP configuration method.
• public bool never_default { get; set; }
  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.
• public Ternary replace_local_rule { get; set; }
  Connections will default to keep the autogenerated priority 0 local rule unless this setting is set to true.
• public int required_timeout { get; set; }
  The minimum time interval in milliseconds for which dynamic IP configuration should be tried before the connection succeeds.
• public int64 route_metric { get; set; }
  The default metric for routes that don't explicitly specify a metric.
• public uint route_table { get; set; }
  Enable policy routing (source routing) and set the routing table used when adding routes.
• public int routed_dns { get; set; }
  Whether to add routes for DNS servers.
• public GenericArray<IPRoute> routes { owned get; set; }
  Array of IP routes.
• public int shared_dhcp_lease_time { get; set; }
  This option allows you to specify a custom DHCP lease time for the shared connection method in seconds.
• public string shared_dhcp_range { owned get; set; }
  This option allows you to specify a custom DHCP range for the shared connection method.

Creation methods:

• protected SettingIPConfig ()

Methods:

• public bool add_address (IPAddress address)
  Adds a new IP address and associated information to the setting.
• public void add_dhcp_reject_server (string server)
  Adds a new DHCP reject server to the setting.
• public bool add_dns (string dns)
  Adds a new DNS server to the setting.
• public bool add_dns_option (string dns_option)
  Adds a new DNS option to the setting.
• public bool add_dns_search (string dns_search)
  Adds a new DNS search domain to the setting.
• public bool add_route (IPRoute route)
  Appends a new route and associated information to the setting.
• public void add_routing_rule (IPRoutingRule routing_rule)
  Appends a new routing-rule and associated information to the setting.
• public void clear_addresses ()
  Removes all configured addresses.
• public void clear_dhcp_reject_servers ()
  Removes all configured DHCP reject servers.
• public void clear_dns ()
  Removes all configured DNS servers.
• public void clear_dns_options (bool is_set)
  Removes all configured DNS options.
• public void clear_dns_searches ()
  Removes all configured DNS search domains.
• public void clear_routes ()
  Removes all configured routes.
• public void clear_routing_rules ()
  Removes all configured routing rules.
• public unowned IPAddress get_address (int idx)
• public Ternary get_auto_route_ext_gw ()
• public int get_dad_timeout ()
• public unowned string get_dhcp_dscp ()
  Returns the value contained in the dhcp_dscp property.
• public unowned string get_dhcp_hostname ()
  Returns the value contained in the dhcp_hostname property.
• public DhcpHostnameFlags get_dhcp_hostname_flags ()
  Returns the value contained in the dhcp_hostname_flags property.
• public unowned string get_dhcp_iaid ()
  Returns the value contained in the dhcp_iaid property.
• public unowned string[] get_dhcp_reject_servers ()
• public bool get_dhcp_send_hostname ()
  Returns the value contained in the dhcp_send_hostname property.
• public Ternary get_dhcp_send_hostname_v2 ()
  Returns the value contained in the dhcp_send_hostname_v2 property.
• public Ternary get_dhcp_send_release ()
• public int get_dhcp_timeout ()
  Returns the value contained in the dhcp_timeout property.
• public unowned string get_dns (int idx)
• public unowned string get_dns_option (uint idx)
  Since 1.46, access at index "len" is allowed and returns NULL.
• public int get_dns_priority ()
• public unowned string get_dns_search (int idx)
  Since 1.46, access at index "len" is allowed and returns NULL.
• public SettingIPConfigForwarding get_forwarding ()
• public unowned string get_gateway ()
• public bool get_ignore_auto_dns ()
  Returns the value contained in the ignore_auto_dns property.
• public bool get_ignore_auto_routes ()
  Returns the value contained in the ignore_auto_routes property.
• public bool get_may_fail ()
  Returns the value contained in the may_fail property.
• public unowned string get_method ()
• public bool get_never_default ()
  Returns the value contained in the never_default property.
• public uint get_num_addresses ()
• public uint get_num_dns ()
• public uint get_num_dns_options ()
• public uint get_num_dns_searches ()
• public uint get_num_routes ()
• public uint get_num_routing_rules ()
• public Ternary get_replace_local_rule ()
• public int get_required_timeout ()
  Returns the value contained in the required_timeout property.
• public unowned IPRoute get_route (int idx)
• public int64 get_route_metric ()
  Returns the value contained in the route_metric property.
• public uint32 get_route_table ()
  Returns the value contained in the route_table property.
• public SettingIPConfigRoutedDns get_routed_dns ()
• public unowned IPRoutingRule get_routing_rule (uint idx)
• public int get_shared_dhcp_lease_time ()
  Returns the value contained in the shared_dhcp_lease_time property.
• public unowned string get_shared_dhcp_range ()
  Returns the value contained in the shared_dhcp_range property.
• public bool has_dns_options ()
  NMSettingIPConfig can have a list of dns-options.
• public void remove_address (int idx)
  Removes the address at index idx.
• public bool remove_address_by_value (IPAddress address)
  Removes the address address.
• public void remove_dhcp_reject_server (uint idx)
  Removes the DHCP reject server at index idx.
• public void remove_dns (int idx)
  Removes the DNS server at index idx.
• public bool remove_dns_by_value (string dns)
  Removes the DNS server dns.
• public void remove_dns_option (int idx)
  Removes the DNS option at index idx.
• public bool remove_dns_option_by_value (string dns_option)
  Removes the DNS option dns_option.
• public void remove_dns_search (int idx)
  Removes the DNS search domain at index idx.
• public bool remove_dns_search_by_value (string dns_search)
  Removes the DNS search domain dns_search.
• public void remove_route (int idx)
  Removes the route at index idx.
• public bool remove_route_by_value (IPRoute route)
  Removes the first matching route that matches route.
• public void remove_routing_rule (uint idx)
  Removes the routing_rule at index idx.

Inherited Members: