:orphan: .. index:: pair: group; Network topology configuration of Test Agents .. _doxid-group__tapi__conf__net: Network topology configuration of Test Agents ============================================= .. toctree:: :hidden: enum_cfg_nat_setup_t.rst enum_net_node_rsrc_type.rst enum_net_node_type.rst struct_cfg_net_node_t.rst struct_cfg_net_pci_info_t.rst struct_cfg_net_t.rst struct_cfg_nets_t.rst struct_tapi_cfg_net_assigned.rst Overview ~~~~~~~~ .. ref-code-block:: cpp :class: doxyrest-overview-code-block // typedefs typedef struct :ref:`cfg_net_node_t` :ref:`cfg_net_node_t`; typedef enum :ref:`cfg_nat_setup_t` :ref:`cfg_nat_setup_t`; typedef struct :ref:`cfg_net_t` :ref:`cfg_net_t`; typedef struct :ref:`cfg_nets_t` :ref:`cfg_nets_t`; typedef struct :ref:`cfg_net_pci_info_t` :ref:`cfg_net_pci_info_t`; typedef :ref:`te_errno` :ref:`tapi_cfg_net_node_cb`( cfg_net_t *net, cfg_net_node_t *node, const char *str, cfg_oid *oid, void *cookie ); typedef struct :ref:`tapi_cfg_net_assigned` :ref:`tapi_cfg_net_assigned`; // enums enum :ref:`cfg_nat_setup_t`; enum :ref:`net_node_rsrc_type`; enum :ref:`net_node_type`; // structs struct :ref:`cfg_net_node_t`; struct :ref:`cfg_net_pci_info_t`; struct :ref:`cfg_net_t`; struct :ref:`cfg_nets_t`; struct :ref:`tapi_cfg_net_assigned`; // global functions void :ref:`tapi_cfg_net_init_pci_info`(:ref:`cfg_net_pci_info_t`* pci_info); void :ref:`tapi_cfg_net_free_pci_info`(:ref:`cfg_net_pci_info_t`* pci_info); enum :ref:`net_node_rsrc_type` :ref:`tapi_cfg_net_get_node_rsrc_type`(:ref:`cfg_net_node_t`* node); :ref:`te_errno` :ref:`tapi_cfg_net_get_net`(:ref:`cfg_handle` net_handle, :ref:`cfg_net_t`* net); :ref:`te_errno` :ref:`tapi_cfg_net_get_nets`(:ref:`cfg_nets_t`* nets); void :ref:`tapi_cfg_net_free_net`(:ref:`cfg_net_t`* net); void :ref:`tapi_cfg_net_free_nets`(:ref:`cfg_nets_t`* nets); :ref:`te_errno` :ref:`tapi_cfg_net_register_net`(const char* name, :ref:`cfg_net_t`* net, ...); :ref:`te_errno` :ref:`tapi_cfg_net_unregister_net`(const char* name, :ref:`cfg_net_t`* net); int :ref:`tapi_cfg_net_get_pairs`(enum :ref:`net_node_type` first, enum :ref:`net_node_type` second, unsigned int* p_n_pairs, :ref:`cfg_handle`(**) p_pairs[2]); int :ref:`tapi_cfg_net_find_net_by_node`(const char* oid, char* net); int :ref:`tapi_cfg_net_get_nodes_values`(const char* net_name, enum :ref:`net_node_type` node_type, const char* ta_name, char*** oids); void :ref:`tapi_cfg_net_free_nodes_values`(char** oids); int :ref:`tapi_cfg_net_get_switch_port`(const char* ta_node, unsigned int* p_port); :ref:`te_errno` :ref:`tapi_cfg_net_remove_empty`(void); :ref:`te_errno` :ref:`tapi_cfg_net_foreach_node`(:ref:`tapi_cfg_net_node_cb`* cb, void* cookie); :ref:`te_errno` :ref:`tapi_cfg_net_bind_driver_by_node`(enum :ref:`net_node_type` node_type, enum :ref:`tapi_cfg_driver_type` driver); :ref:`te_errno` :ref:`tapi_cfg_net_get_iut_if_pci_info`(:ref:`cfg_net_pci_info_t`* iut_if_pci_info); :ref:`te_errno` :ref:`tapi_cfg_net_nodes_update_pci_fn_to_interface`(enum :ref:`net_node_type` type); :ref:`te_errno` :ref:`tapi_cfg_net_nodes_switch_pci_fn_to_interface`(enum :ref:`net_node_type` type); :ref:`te_errno` :ref:`tapi_cfg_net_reserve_all`(void); :ref:`te_errno` :ref:`tapi_cfg_net_all_up`(bool force); :ref:`te_errno` :ref:`tapi_cfg_net_delete_all_ip4_addresses`(void); :ref:`te_errno` :ref:`tapi_cfg_net_delete_all_ip6_addresses`(void); :ref:`te_errno` :ref:`tapi_cfg_net_all_check_mtu`(void); int :ref:`tapi_cfg_net_assign_ip`(unsigned int af, :ref:`cfg_net_t`* net, :ref:`tapi_cfg_net_assigned`* assigned); :ref:`te_errno` :ref:`tapi_cfg_net_unassign_ip`(unsigned int af, :ref:`cfg_net_t`* net, :ref:`tapi_cfg_net_assigned`* assigned); :ref:`te_errno` :ref:`tapi_cfg_net_all_assign_ip`(unsigned int af); int :ref:`tapi_cfg_net_assign_ip_one_end`(unsigned int af, :ref:`cfg_net_t`* net, :ref:`tapi_cfg_net_assigned`* assigned); :ref:`cfg_net_node_t`* :ref:`tapi_cfg_net_get_gateway`(const :ref:`cfg_net_t`* net_src, const :ref:`cfg_net_t`* net_tgt); :ref:`te_errno` :ref:`tapi_cfg_net_assigned_get_subnet_ip`(:ref:`tapi_cfg_net_assigned`* assigned, struct sockaddr** addr, unsigned int* prefix_len); :ref:`te_errno` :ref:`tapi_cfg_net_delete_all`(void); :ref:`te_errno` :ref:`tapi_cfg_net_create_routes`(unsigned int af); :ref:`te_errno` :ref:`tapi_cfg_net_create_nat`(unsigned int af); :ref:`te_errno` :ref:`tapi_cfg_net_node_get_pci_oids`(const :ref:`cfg_net_node_t`* node, unsigned int* n_pci, char*** pci_oids); :ref:`te_errno` :ref:`tapi_cfg_net_node_interface`(const char* node_value, char** iface_name); .. _details-group__tapi__conf__net: Detailed Documentation ~~~~~~~~~~~~~~~~~~~~~~ Typedefs -------- .. index:: pair: typedef; cfg_net_node_t .. _doxid-group__tapi__conf__net_1ga5ea8d933df0a764eefd56fa61d3e78df: .. ref-code-block:: cpp :class: doxyrest-title-code-block typedef struct :ref:`cfg_net_node_t` cfg_net_node_t Node description structure .. index:: pair: typedef; cfg_nat_setup_t .. _doxid-group__tapi__conf__net_1gaef2e6848253746748bd16ccbe3384ac0: .. ref-code-block:: cpp :class: doxyrest-title-code-block typedef enum :ref:`cfg_nat_setup_t` cfg_nat_setup_t Supported NAT setup procedures .. index:: pair: typedef; cfg_net_t .. _doxid-group__tapi__conf__net_1ga8dc053dbdb882b5860a807d7740fa118: .. ref-code-block:: cpp :class: doxyrest-title-code-block typedef struct :ref:`cfg_net_t` cfg_net_t Net description structure .. index:: pair: typedef; cfg_nets_t .. _doxid-group__tapi__conf__net_1ga85f191dd53b0365a98be52359d932e06: .. ref-code-block:: cpp :class: doxyrest-title-code-block typedef struct :ref:`cfg_nets_t` cfg_nets_t Nets description structure .. index:: pair: typedef; cfg_net_pci_info_t .. _doxid-group__tapi__conf__net_1gaad59825eef1a5e918dd2bf991bd2023e: .. ref-code-block:: cpp :class: doxyrest-title-code-block typedef struct :ref:`cfg_net_pci_info_t` cfg_net_pci_info_t PCI device of node description structure .. index:: pair: typedef; tapi_cfg_net_node_cb .. _doxid-group__tapi__conf__net_1gae1541cc041675a9d10f4de1c32a4d0dc: .. ref-code-block:: cpp :class: doxyrest-title-code-block typedef :ref:`te_errno` tapi_cfg_net_node_cb( cfg_net_t *net, cfg_net_node_t *node, const char *str, cfg_oid *oid, void *cookie ) Prototype of the function to be called for each node. Iterator terminates if callback returns non zero. .. rubric:: Parameters: .. list-table:: :widths: 20 80 * - net - Network the node belongs to * - node - Node itself * - str - Node OID value in string format * - oid - Parsed node OID * - cookie - Callback opaque data .. rubric:: Returns: Status code. .. index:: pair: typedef; tapi_cfg_net_assigned .. _doxid-group__tapi__conf__net_1gaa524361c33d7dc6e086f7882d37f1cf1: .. ref-code-block:: cpp :class: doxyrest-title-code-block typedef struct :ref:`tapi_cfg_net_assigned` tapi_cfg_net_assigned Information about made assignments Global Functions ---------------- .. index:: pair: function; tapi_cfg_net_init_pci_info .. _doxid-group__tapi__conf__net_1gac8a624c39a836351ca5d0d6b029c3588: .. ref-code-block:: cpp :class: doxyrest-title-code-block void tapi_cfg_net_init_pci_info(:ref:`cfg_net_pci_info_t`* pci_info) Initialize PCI device info structure. .. rubric:: Parameters: .. list-table:: :widths: 20 80 * - pci_info - Pointer to PCI info structure. .. index:: pair: function; tapi_cfg_net_free_pci_info .. _doxid-group__tapi__conf__net_1gaecb6f4898e66ef5fd053b455ea7f694b: .. ref-code-block:: cpp :class: doxyrest-title-code-block void tapi_cfg_net_free_pci_info(:ref:`cfg_net_pci_info_t`* pci_info) Free resources allocated for info of PCI device. .. rubric:: Parameters: .. list-table:: :widths: 20 80 * - pci_info - Pointer to PCI info structure. .. index:: pair: function; tapi_cfg_net_get_node_rsrc_type .. _doxid-group__tapi__conf__net_1gac5d88101b4321c8f7d8d0a74d221fb15: .. ref-code-block:: cpp :class: doxyrest-title-code-block enum :ref:`net_node_rsrc_type` tapi_cfg_net_get_node_rsrc_type(:ref:`cfg_net_node_t`* node) Get type of the network node resource. Returns cached value if it is already known and tries to fill in cache otherwise. .. index:: pair: function; tapi_cfg_net_get_net .. _doxid-group__tapi__conf__net_1ga2cefc87265e2289145e5142324660e1d: .. ref-code-block:: cpp :class: doxyrest-title-code-block :ref:`te_errno` tapi_cfg_net_get_net(:ref:`cfg_handle` net_handle, :ref:`cfg_net_t`* net) Get configuration of the net. @retval Status code. .. rubric:: Parameters: .. list-table:: :widths: 20 80 * - net_handle - Configurator handle of the net to get * - net - Location for net data (OUT) .. index:: pair: function; tapi_cfg_net_get_nets .. _doxid-group__tapi__conf__net_1ga32abaef4d938fa5b804823d8672f2a36: .. ref-code-block:: cpp :class: doxyrest-title-code-block :ref:`te_errno` tapi_cfg_net_get_nets(:ref:`cfg_nets_t`* nets) Get nets configuration. .. rubric:: Parameters: .. list-table:: :widths: 20 80 * - nets - Pointer to nets description structure (OUT) * - Status - code. .. index:: pair: function; tapi_cfg_net_free_net .. _doxid-group__tapi__conf__net_1ga10db52482774c26c36077f35d757ac76: .. ref-code-block:: cpp :class: doxyrest-title-code-block void tapi_cfg_net_free_net(:ref:`cfg_net_t`* net) Free network dump structure. .. rubric:: Parameters: .. list-table:: :widths: 20 80 * - net - Pointer to net description structure .. index:: pair: function; tapi_cfg_net_free_nets .. _doxid-group__tapi__conf__net_1ga6c75bb72bc4c4033f7e5a3700fc23ccd: .. ref-code-block:: cpp :class: doxyrest-title-code-block void tapi_cfg_net_free_nets(:ref:`cfg_nets_t`* nets) Free networks dump structure. .. rubric:: Parameters: .. list-table:: :widths: 20 80 * - nets - Pointer to nets description structure .. index:: pair: function; tapi_cfg_net_register_net .. _doxid-group__tapi__conf__net_1gac820d6da8c5abb868aa10654d1c3864c: .. ref-code-block:: cpp :class: doxyrest-title-code-block :ref:`te_errno` tapi_cfg_net_register_net(const char* name, :ref:`cfg_net_t`* net, ...) Register a new network in '/net' CM tree. The function could be useful when you need to build a network dynamically (for example if you want to build some L3 network with a set of nodes, which you later want to assign IP addresses or do some other stuff available for ' :ref:`cfg_net_t ` ' data types). Other parameters are pairs of type: * "const char \*node_oid_str" - the value of '/net/node' instance to be added into a newly created network; * "enum net_node_type node_type" - node type value of '/net/node/type' instance. Trailing NULL tells there is no more pairs. .. rubric:: Parameters: .. list-table:: :widths: 20 80 * - name - network name to assign * - net - placeholder for a network data to be filled in .. rubric:: Returns: Status of the operation. .. index:: pair: function; tapi_cfg_net_unregister_net .. _doxid-group__tapi__conf__net_1ga70788ee102cc51745c085ee3d40342f7: .. ref-code-block:: cpp :class: doxyrest-title-code-block :ref:`te_errno` tapi_cfg_net_unregister_net(const char* name, :ref:`cfg_net_t`* net) Unregister net previously registered with :ref:`tapi_cfg_net_register_net() ` function. .. rubric:: Parameters: .. list-table:: :widths: 20 80 * - name - network name to unregister * - net - network data structure (previously filled in with :ref:`tapi_cfg_net_register_net() ` function) .. rubric:: Returns: Status of the operation. .. index:: pair: function; tapi_cfg_net_get_pairs .. _doxid-group__tapi__conf__net_1gab92c261834780a3c21ba40bc99ffb005: .. ref-code-block:: cpp :class: doxyrest-title-code-block int tapi_cfg_net_get_pairs(enum :ref:`net_node_type` first, enum :ref:`net_node_type` second, unsigned int* p_n_pairs, :ref:`cfg_handle`(**) p_pairs[2]) Get pair (if available) from each configured network. .. rubric:: Parameters: .. list-table:: :widths: 20 80 * - first - - type of the first node * - second - - type of the second node * - p_n_pairs - - location for number of found pairs * - p_pairs - - location for array of found pairs .. rubric:: Returns: Status code. .. index:: pair: function; tapi_cfg_net_find_net_by_node .. _doxid-group__tapi__conf__net_1ga9a5845e39d27f7de41ea487e251b8b6d: .. ref-code-block:: cpp :class: doxyrest-title-code-block int tapi_cfg_net_find_net_by_node(const char* oid, char* net) Find 'net' with node value equal to provided OID. .. rubric:: Parameters: .. list-table:: :widths: 20 80 * - oid - - search value * - net - - location for net name (at least CFG_INST_NAME_MAX) .. rubric:: Returns: Status code. .. index:: pair: function; tapi_cfg_net_get_nodes_values .. _doxid-group__tapi__conf__net_1ga7ee240c863692318d3a76097b10511e3: .. ref-code-block:: cpp :class: doxyrest-title-code-block int tapi_cfg_net_get_nodes_values(const char* net_name, enum :ref:`net_node_type` node_type, const char* ta_name, char*** oids) For the given network, it returns the list of values gathered on the nodes of specified type. The function allocates memory under an array of pointers to the values. The last element of this array is set to NULL. Deallocate this memory with tapi_cfg_net_free_nodes_values. .. rubric:: Parameters: .. list-table:: :widths: 20 80 * - net_name - - name of the network * - node_type - - type of the node to find * - ta_name - - name of the agent or NULL if it does not matter * - oids - - location for the list of values (OUT) * - Status - of the operation * - TE_ENOENT - The network does not have any node of specified type attached .. rubric:: See also: :ref:`tapi_cfg_net_free_nodes_values ` .. index:: pair: function; tapi_cfg_net_free_nodes_values .. _doxid-group__tapi__conf__net_1ga540502e7f37d0cb2c8c695e19044f799: .. ref-code-block:: cpp :class: doxyrest-title-code-block void tapi_cfg_net_free_nodes_values(char** oids) Frees memory allocated with tapi_cfg_net_get_nodes_values function. .. rubric:: Parameters: .. list-table:: :widths: 20 80 * - oids - - Pointer returned with tapi_cfg_net_get_nodes_values .. rubric:: See also: :ref:`tapi_cfg_net_get_nodes_values ` .. index:: pair: function; tapi_cfg_net_get_switch_port .. _doxid-group__tapi__conf__net_1gae1e3c72ff2b52a22be720b762483c93b: .. ref-code-block:: cpp :class: doxyrest-title-code-block int tapi_cfg_net_get_switch_port(const char* ta_node, unsigned int* p_port) Get number of the switch port to which specified TA connected. .. rubric:: Parameters: .. list-table:: :widths: 20 80 * - ta_node - - OID of TA node in net configuration model * - p_port - - location for port number .. rubric:: Returns: Status code. .. index:: pair: function; tapi_cfg_net_remove_empty .. _doxid-group__tapi__conf__net_1gac099a14e887a1c009e01c9c22d071827: .. ref-code-block:: cpp :class: doxyrest-title-code-block :ref:`te_errno` tapi_cfg_net_remove_empty(void) Remove networks with empty interface names from the CS database. .. rubric:: Returns: Status code. .. index:: pair: function; tapi_cfg_net_foreach_node .. _doxid-group__tapi__conf__net_1ga0662ff3bc4030e6fa97438062a6708ea: .. ref-code-block:: cpp :class: doxyrest-title-code-block :ref:`te_errno` tapi_cfg_net_foreach_node(:ref:`tapi_cfg_net_node_cb`* cb, void* cookie) Execute callback for each node. .. rubric:: Parameters: .. list-table:: :widths: 20 80 * - cb - Callback function * - cookie - Callback opaque data .. rubric:: Returns: Status code. .. index:: pair: function; tapi_cfg_net_bind_driver_by_node .. _doxid-group__tapi__conf__net_1ga9acc16bda6b08622961d1c4daaa9d513: .. ref-code-block:: cpp :class: doxyrest-title-code-block :ref:`te_errno` tapi_cfg_net_bind_driver_by_node(enum :ref:`net_node_type` node_type, enum :ref:`tapi_cfg_driver_type` driver) Bind a driver (with specified type) on a PCI function referenced by every net node matching ``node_type``. The driver names for specific types are discovered from "/local" configurator tree (e.g. "/local/net_driver"). Net nodes are expected to reference PCI functions, in case when a node references net interface: * if ``NET_DRIVER_TYPE_NET`` is passed, the function succeeds without performing bind, * if passed ``driver`` is not ``NET_DRIVER_TYPE_NET`` bind fails .. rubric:: Parameters: .. list-table:: :widths: 20 80 * - node_type - Node type of nets on which bind is performed * - driver - Driver type to bind .. rubric:: Returns: Status code. .. index:: pair: function; tapi_cfg_net_get_iut_if_pci_info .. _doxid-group__tapi__conf__net_1gabe1baf71c4a69baaeabdf765744ce681: .. ref-code-block:: cpp :class: doxyrest-title-code-block :ref:`te_errno` tapi_cfg_net_get_iut_if_pci_info(:ref:`cfg_net_pci_info_t`* iut_if_pci_info) Fill PCI device info of IUT node. .. rubric:: Parameters: .. list-table:: :widths: 20 80 * - iut_if_pci_info - Pointer to PCI info structure of IUT node. .. rubric:: Returns: Status code. .. index:: pair: function; tapi_cfg_net_nodes_update_pci_fn_to_interface .. _doxid-group__tapi__conf__net_1gaae462e7c12e24ef599e53be4e0ae0a33: .. ref-code-block:: cpp :class: doxyrest-title-code-block :ref:`te_errno` tapi_cfg_net_nodes_update_pci_fn_to_interface(enum :ref:`net_node_type` type) Update network nodes specified in terms of PCI function and bound to network driver to refer to corresponding network interfaces. The interface is reserved as a resource. Partially done changes are not rolled back in the case of failure. .. rubric:: Parameters: .. list-table:: :widths: 20 80 * - type - Network node type of the nodes to update, pass ``NET_NODE_TYPE_INVALID`` to update all network nodes .. rubric:: Returns: Status code. .. rubric:: See also: :ref:`tapi_cfg_net_bind_driver_by_node() ` :ref:`tapi_cfg_net_nodes_switch_pci_fn_to_interface() ` .. index:: pair: function; tapi_cfg_net_nodes_switch_pci_fn_to_interface .. _doxid-group__tapi__conf__net_1gaa60a0bf67977f168604170da3a3326f6: .. ref-code-block:: cpp :class: doxyrest-title-code-block :ref:`te_errno` tapi_cfg_net_nodes_switch_pci_fn_to_interface(enum :ref:`net_node_type` type) Switch network nodes specified in terms of PCI function to network interfaces incluing rebind the PCI function to network driver. Partially done changes are not rolled back in the case of failure. .. rubric:: Parameters: .. list-table:: :widths: 20 80 * - type - Network node type of the nodes to switch, pass ``NET_NODE_TYPE_INVALID`` to switch all network nodes .. rubric:: Returns: Status code. .. index:: pair: function; tapi_cfg_net_reserve_all .. _doxid-group__tapi__conf__net_1ga6e87025907572f21d63b744b6ffcb1e4: .. ref-code-block:: cpp :class: doxyrest-title-code-block :ref:`te_errno` tapi_cfg_net_reserve_all(void) Reserve resources for all interfaces mentioned in networks configuration. .. rubric:: Returns: Status code. .. index:: pair: function; tapi_cfg_net_all_up .. _doxid-group__tapi__conf__net_1gabaf645c57933f86d4a241c2560543dad: .. ref-code-block:: cpp :class: doxyrest-title-code-block :ref:`te_errno` tapi_cfg_net_all_up(bool force) Set UP state for all interfaces (nodes) of networks configuration. .. rubric:: Parameters: .. list-table:: :widths: 20 80 * - force - If interface is already UP, push it down and up again .. rubric:: Returns: Status code. .. index:: pair: function; tapi_cfg_net_delete_all_ip4_addresses .. _doxid-group__tapi__conf__net_1ga74f3f3a5dc59a1438c28738bfb5f6e10: .. ref-code-block:: cpp :class: doxyrest-title-code-block :ref:`te_errno` tapi_cfg_net_delete_all_ip4_addresses(void) Delete IPv4 addresses from all nodes in networks configuration. .. rubric:: Returns: Status code. .. index:: pair: function; tapi_cfg_net_delete_all_ip6_addresses .. _doxid-group__tapi__conf__net_1ga8f544d8ce10d203659ad5b2062fea5cd: .. ref-code-block:: cpp :class: doxyrest-title-code-block :ref:`te_errno` tapi_cfg_net_delete_all_ip6_addresses(void) Delete IPv6 addresses (except link-local) from all nodes in networks configuration. .. rubric:: Returns: Status code. .. index:: pair: function; tapi_cfg_net_all_check_mtu .. _doxid-group__tapi__conf__net_1ga2e7063765e252b3fb9997a876b2efc24: .. ref-code-block:: cpp :class: doxyrest-title-code-block :ref:`te_errno` tapi_cfg_net_all_check_mtu(void) Check all configuration networks that MTU values on the ends of each network does not differ .. rubric:: Returns: Status code. .. index:: pair: function; tapi_cfg_net_assign_ip .. _doxid-group__tapi__conf__net_1ga7459008a21db68b48df5032cea1dda5d: .. ref-code-block:: cpp :class: doxyrest-title-code-block int tapi_cfg_net_assign_ip(unsigned int af, :ref:`cfg_net_t`* net, :ref:`tapi_cfg_net_assigned`* assigned) Assign IP subnet to specified configuration network. If assigned is NULL or assigned->pool is CFG_HANDLE_INVALID, IP subnet is allocated using :ref:`tapi_cfg_alloc_entry ` from /net_pool:ip4 or /net_pool:ip6. Its handle is returned in assigned->pool. Pool entries assigned to net nodes are returned as array assigned->entries. Order of elements in the same as order of nodes in net->nodes array. .. rubric:: Parameters: .. list-table:: :widths: 20 80 * - af - Address family * - net - Configuration network * - assigned - Information about done assignments .. rubric:: Returns: Status code. .. index:: pair: function; tapi_cfg_net_unassign_ip .. _doxid-group__tapi__conf__net_1ga93f94b680a28cda071b376c9ad5cec66: .. ref-code-block:: cpp :class: doxyrest-title-code-block :ref:`te_errno` tapi_cfg_net_unassign_ip(unsigned int af, :ref:`cfg_net_t`* net, :ref:`tapi_cfg_net_assigned`* assigned) Reset previously assigned IP addresses from a network. .. rubric:: Parameters: .. list-table:: :widths: 20 80 * - af - Address family * - net - Configuration network * - assigned - Information about done assignments (to be unregistered) .. rubric:: Returns: Status of the operation. .. index:: pair: function; tapi_cfg_net_all_assign_ip .. _doxid-group__tapi__conf__net_1ga1dad9bdcf325f61c75480ea3b7f8e646: .. ref-code-block:: cpp :class: doxyrest-title-code-block :ref:`te_errno` tapi_cfg_net_all_assign_ip(unsigned int af) Assign IP subnets for all configuration network. .. rubric:: Parameters: .. list-table:: :widths: 20 80 * - af - Address family .. rubric:: Returns: Status code. .. index:: pair: function; tapi_cfg_net_assign_ip_one_end .. _doxid-group__tapi__conf__net_1ga31173bc17e36516217d20d08815e1d7f: .. ref-code-block:: cpp :class: doxyrest-title-code-block int tapi_cfg_net_assign_ip_one_end(unsigned int af, :ref:`cfg_net_t`* net, :ref:`tapi_cfg_net_assigned`* assigned) Dirty hack, must be removed after sockts_get_host_addr() will be repaired. .. index:: pair: function; tapi_cfg_net_get_gateway .. _doxid-group__tapi__conf__net_1gaf7d9f1a57a87dd42f52f8ea062670710: .. ref-code-block:: cpp :class: doxyrest-title-code-block :ref:`cfg_net_node_t`* tapi_cfg_net_get_gateway(const :ref:`cfg_net_t`* net_src, const :ref:`cfg_net_t`* net_tgt) Get gateway node between two given networks. .. rubric:: Parameters: .. list-table:: :widths: 20 80 * - net_src - Source network. * - net_tgt - Target network. .. rubric:: Returns: Network node. .. index:: pair: function; tapi_cfg_net_assigned_get_subnet_ip .. _doxid-group__tapi__conf__net_1ga365a587f66c9de4fcb986c1b7fc3e167: .. ref-code-block:: cpp :class: doxyrest-title-code-block :ref:`te_errno` tapi_cfg_net_assigned_get_subnet_ip(:ref:`tapi_cfg_net_assigned`* assigned, struct sockaddr** addr, unsigned int* prefix_len) Obtain information about subnet address and prefix length. .. rubric:: Parameters: .. list-table:: :widths: 20 80 * - assigned - subnet assignments handle * - addr - subnet address (OUT) * - prefix_len - subnet prefix length (OUT) .. rubric:: Returns: Status of the operation .. index:: pair: function; tapi_cfg_net_delete_all .. _doxid-group__tapi__conf__net_1ga9749e71f78c79c38b63c74576f522060: .. ref-code-block:: cpp :class: doxyrest-title-code-block :ref:`te_errno` tapi_cfg_net_delete_all(void) Delete all nets from network configuration. .. rubric:: Returns: Status code (see ``te_errno.h``) .. index:: pair: function; tapi_cfg_net_create_routes .. _doxid-group__tapi__conf__net_1ga1e29c9dc2a6527b1a03432419470553f: .. ref-code-block:: cpp :class: doxyrest-title-code-block :ref:`te_errno` tapi_cfg_net_create_routes(unsigned int af) Create routes within virtual networks. .. rubric:: Parameters: .. list-table:: :widths: 20 80 * - af - Address family. .. rubric:: Returns: Status code (see ``te_errno.h``). .. index:: pair: function; tapi_cfg_net_create_nat .. _doxid-group__tapi__conf__net_1ga1d738fd3a2737c60b07b6e8cf6601d1a: .. ref-code-block:: cpp :class: doxyrest-title-code-block :ref:`te_errno` tapi_cfg_net_create_nat(unsigned int af) Create iptables for NAT networks. .. rubric:: Parameters: .. list-table:: :widths: 20 80 * - af - Address family. .. rubric:: Returns: Status code (see ``te_errno.h``). .. index:: pair: function; tapi_cfg_net_node_get_pci_oids .. _doxid-group__tapi__conf__net_1gaf342a202c223ebb5e61d761af5866141: .. ref-code-block:: cpp :class: doxyrest-title-code-block :ref:`te_errno` tapi_cfg_net_node_get_pci_oids(const :ref:`cfg_net_node_t`* node, unsigned int* n_pci, char*** pci_oids) Get PCI devices associated with a network node. .. rubric:: Parameters: .. list-table:: :widths: 20 80 * - node - Network node configuration * - n_pci - Number of PCI devices * - pci_oids - PCI device object identifiers (/agent/hardware/pci/device) .. rubric:: Returns: Status code .. index:: pair: function; tapi_cfg_net_node_interface .. _doxid-group__tapi__conf__net_1ga0c76372ec2e3fa1e4d545bd49fcff108: .. ref-code-block:: cpp :class: doxyrest-title-code-block :ref:`te_errno` tapi_cfg_net_node_interface(const char* node_value, char** iface_name) Get network node interface name by PCI instance with or without netdev. Instances of the following CS objects are supported: * /agent/hardware/pci/vendor/device/instance * /agent/hardware/pci/vendor/device/instance/netdev * /agent/interface .. rubric:: Parameters: .. list-table:: :widths: 20 80 * - node_value - network node value * - iface_name - location for interface name .. rubric:: Returns: Status code.