network#

Autogenerated API

argus_api.lib.customernetworks.v1.network.add_customer_network(customer: str = None, location: str = None, flagsToSet: str = None, zone: str = None, description: str = None, networkAddress: str = None, verified: bool = True, json: bool = True, verify: Optional[bool] = None, proxies: Optional[dict] = None, apiKey: Optional[str] = None, authentication: Optional[dict] = None, server_url: Optional[str] = None, body: Optional[dict] = None, api_session: Optional[ArgusAPISession] = None) → dict#

Add new customer network (PUBLIC)

Parameters

  • customer (str) – Customer ID or short name of the customer that the network belongs to

  • location (str) – DEPRECATED. Location ID or short name of the location where the network is located (default 0)

  • flagsToSet (list) – Flags to set for the network

  • zone (str) – Zone of the network

  • description (str) – Description of the customer network. Maximum number of characters is 255.

  • networkAddress (str) – IP address of the customer network => format:ip

  • verified (bool) – DEPRECATED. Whether to create the network already Verified. (default true)

  • json – return the response’s body as a dict parsed from json. True by default. If set to false, the raw requests.Response object will be returned.

  • verify – path to a certificate bundle or boolean indicating whether SSL verification should be performed.

  • apiKey – Argus API key.

  • authentication – authentication override

  • server_url – API base URL override

  • body – body of the request. other parameters will override keys defined in the body.

  • api_session – session to use for this request. If not set, the global session will be used.

Raises
Returns

dictionary translated from JSON

argus_api.lib.customernetworks.v1.network.add_customer_network_comment(networkID: int, comment: str = None, json: bool = True, verify: Optional[bool] = None, proxies: Optional[dict] = None, apiKey: Optional[str] = None, authentication: Optional[dict] = None, server_url: Optional[str] = None, body: Optional[dict] = None, api_session: Optional[ArgusAPISession] = None) → dict#

Add comment for customer network (PUBLIC)

Parameters

  • networkID (int) – ID of network to update

  • comment (str) – Comment to add to the network => [sw\{\}\$\-\(\).\[\]”'_/\,\*\+\#:@!?;=]*

  • json – return the response’s body as a dict parsed from json. True by default. If set to false, the raw requests.Response object will be returned.

  • verify – path to a certificate bundle or boolean indicating whether SSL verification should be performed.

  • apiKey – Argus API key.

  • authentication – authentication override

  • server_url – API base URL override

  • body – body of the request. other parameters will override keys defined in the body.

  • api_session – session to use for this request. If not set, the global session will be used.

Raises
Returns

dictionary translated from JSON

argus_api.lib.customernetworks.v1.network.bulk_add_customer_networks(networks: dict = None, customer: str = None, overwrite: bool = True, verified: bool = True, json: bool = True, verify: Optional[bool] = None, proxies: Optional[dict] = None, apiKey: Optional[str] = None, authentication: Optional[dict] = None, server_url: Optional[str] = None, body: Optional[dict] = None, api_session: Optional[ArgusAPISession] = None) → dict#

Bulk add/update customer networks (PUBLIC)

Parameters

  • networks (list) –

  • customer (str) – Customer ID or short name of the customer that the networks belong to

  • overwrite (bool) – Overwrite existing networks configuration (default true)

  • verified (bool) – DEPRECATED. Whether to create the networks already Verified. (default true)

  • json – return the response’s body as a dict parsed from json. True by default. If set to false, the raw requests.Response object will be returned.

  • verify – path to a certificate bundle or boolean indicating whether SSL verification should be performed.

  • apiKey – Argus API key.

  • authentication – authentication override

  • server_url – API base URL override

  • body – body of the request. other parameters will override keys defined in the body.

  • api_session – session to use for this request. If not set, the global session will be used.

Raises
Returns

dictionary translated from JSON

argus_api.lib.customernetworks.v1.network.delete_customer_network(networkID: int, json: bool = True, verify: Optional[bool] = None, proxies: Optional[dict] = None, apiKey: Optional[str] = None, authentication: Optional[dict] = None, server_url: Optional[str] = None, body: Optional[dict] = None, api_session: Optional[ArgusAPISession] = None) → dict#

Delete customer network (PUBLIC)

Parameters

  • networkID (int) – ID of network to delete

  • json – return the response’s body as a dict parsed from json. True by default. If set to false, the raw requests.Response object will be returned.

  • verify – path to a certificate bundle or boolean indicating whether SSL verification should be performed.

  • apiKey – Argus API key.

  • authentication – authentication override

  • server_url – API base URL override

  • body – body of the request. other parameters will override keys defined in the body.

  • api_session – session to use for this request. If not set, the global session will be used.

Raises
Returns

dictionary translated from JSON

argus_api.lib.customernetworks.v1.network.delete_customer_network_comment(networkID: int, commentID: str, json: bool = True, verify: Optional[bool] = None, proxies: Optional[dict] = None, apiKey: Optional[str] = None, authentication: Optional[dict] = None, server_url: Optional[str] = None, body: Optional[dict] = None, api_session: Optional[ArgusAPISession] = None) → dict#

Delete comment from customer network (PUBLIC)

Parameters

  • networkID (int) – ID of parent network

  • commentID (str) – ID of comment to delete

  • json – return the response’s body as a dict parsed from json. True by default. If set to false, the raw requests.Response object will be returned.

  • verify – path to a certificate bundle or boolean indicating whether SSL verification should be performed.

  • apiKey – Argus API key.

  • authentication – authentication override

  • server_url – API base URL override

  • body – body of the request. other parameters will override keys defined in the body.

  • api_session – session to use for this request. If not set, the global session will be used.

Raises
Returns

dictionary translated from JSON

argus_api.lib.customernetworks.v1.network.get_customer_network(networkID: int, json: bool = True, verify: Optional[bool] = None, proxies: Optional[dict] = None, apiKey: Optional[str] = None, authentication: Optional[dict] = None, server_url: Optional[str] = None, body: Optional[dict] = None, api_session: Optional[ArgusAPISession] = None) → dict#

Get customer network (PUBLIC)

Parameters

  • networkID (int) – ID of network to get

  • json – return the response’s body as a dict parsed from json. True by default. If set to false, the raw requests.Response object will be returned.

  • verify – path to a certificate bundle or boolean indicating whether SSL verification should be performed.

  • apiKey – Argus API key.

  • authentication – authentication override

  • server_url – API base URL override

  • body – body of the request. other parameters will override keys defined in the body.

  • api_session – session to use for this request. If not set, the global session will be used.

Raises
Returns

dictionary translated from JSON

argus_api.lib.customernetworks.v1.network.get_customer_network_comments(networkID: int, limit: int = 25, offset: int = None, json: bool = True, verify: Optional[bool] = None, proxies: Optional[dict] = None, apiKey: Optional[str] = None, authentication: Optional[dict] = None, server_url: Optional[str] = None, body: Optional[dict] = None, api_session: Optional[ArgusAPISession] = None) → dict#

Get network’s comments (PUBLIC)

Parameters

  • networkID (int) – ID of network

  • limit (int) – Maximum number of returned comments

  • offset (int) – Skip a number of comments

  • json – return the response’s body as a dict parsed from json. True by default. If set to false, the raw requests.Response object will be returned.

  • verify – path to a certificate bundle or boolean indicating whether SSL verification should be performed.

  • apiKey – Argus API key.

  • authentication – authentication override

  • server_url – API base URL override

  • body – body of the request. other parameters will override keys defined in the body.

  • api_session – session to use for this request. If not set, the global session will be used.

Raises
Returns

dictionary translated from JSON

argus_api.lib.customernetworks.v1.network.get_customer_networks(customerID: int = None, limit: int = 25, offset: int = None, json: bool = True, verify: Optional[bool] = None, proxies: Optional[dict] = None, apiKey: Optional[str] = None, authentication: Optional[dict] = None, server_url: Optional[str] = None, body: Optional[dict] = None, api_session: Optional[ArgusAPISession] = None) → dict#

Get networks belonging to customer(s) (PUBLIC)

Parameters

  • customerID (list) – ID of customer(s)

  • limit (int) – Maximum number of returned networks

  • offset (int) – Skip a number of networks

  • json – return the response’s body as a dict parsed from json. True by default. If set to false, the raw requests.Response object will be returned.

  • verify – path to a certificate bundle or boolean indicating whether SSL verification should be performed.

  • apiKey – Argus API key.

  • authentication – authentication override

  • server_url – API base URL override

  • body – body of the request. other parameters will override keys defined in the body.

  • api_session – session to use for this request. If not set, the global session will be used.

Raises
Returns

requests.Response object or dictionary translated from JSON

argus_api.lib.customernetworks.v1.network.lenient_bulk_add_customer_networks(networks: dict = None, customer: str = None, domain: str = None, overwrite: bool = True, ignoreOnFailed: bool = None, json: bool = True, verify: Optional[bool] = None, proxies: Optional[dict] = None, apiKey: Optional[str] = None, authentication: Optional[dict] = None, server_url: Optional[str] = None, body: Optional[dict] = None, api_session: Optional[ArgusAPISession] = None) → dict#

Bulk add/update customer networks with the option of ignoring failures (PUBLIC)

Parameters

  • networks (list) –

  • customer (str) – Customer ID or short name of the customer that the networks belong to

  • domain (str) – The domain of the customer. Defaults to the current user’s domain

  • overwrite (bool) – Overwrite existing networks configuration (default true)

  • ignoreOnFailed (bool) – Whether to ignore networks that fails to be added. If true, all networks that can be added, will be added (default false)

  • json – return the response’s body as a dict parsed from json. True by default. If set to false, the raw requests.Response object will be returned.

  • verify – path to a certificate bundle or boolean indicating whether SSL verification should be performed.

  • apiKey – Argus API key.

  • authentication – authentication override

  • server_url – API base URL override

  • body – body of the request. other parameters will override keys defined in the body.

  • api_session – session to use for this request. If not set, the global session will be used.

Raises
Returns

dictionary translated from JSON

argus_api.lib.customernetworks.v1.network.search_customer_network(limit: int = None, offset: int = None, includeDeleted: bool = None, subCriteria: dict = None, exclude: bool = None, required: bool = None, customerID: int = None, addresses: dict = None, keywords: str = None, keywordMatchStrategy: str = None, keywordFieldStrategy: str = None, startTimestamp: int = None, endTimestamp: int = None, timeMatchStrategy: str = None, timeFieldStrategy: str = None, sortBy: str = None, includeFlags: str = None, excludeFlags: str = None, includeSupernet: bool = True, includeSubnet: bool = True, json: bool = True, verify: Optional[bool] = None, proxies: Optional[dict] = None, apiKey: Optional[str] = None, authentication: Optional[dict] = None, server_url: Optional[str] = None, body: Optional[dict] = None, api_session: Optional[ArgusAPISession] = None) → dict#

Search customer network (PUBLIC)

Parameters

  • limit (int) – Max number of results.

  • offset (int) – Skip the first (offset) objects. By default, return result from first object.

  • includeDeleted (bool) – Set to true to include deleted objects. By default, exclude deleted objects.

  • subCriteria (list) – Set additional criterias which are applied using a logical OR.

  • exclude (bool) – Only relevant for subcriteria. If set to true, objects matching this subcriteria object will be excluded.

  • required (bool) – Only relevant for subcriteria. If set to true, objects matching this subcriteria are required (AND-ed together with parent criteria).

  • customerID (list) – Restrict search to data belonging to specified customers.

  • addresses (list) – A set of IP addresses matched against networks

  • keywords (list) – A set of keywords matched against network’s description

  • keywordMatchStrategy (str) – KeywordMatchStrategy to define how keywords are queried for logically i.e. equivalent of AND/OR (default any)

  • keywordFieldStrategy (list) – Defines which fields will be searched by keywords (default all)

  • startTimestamp (int) – Start of time search period

  • endTimestamp (int) – End of time search period

  • timeMatchStrategy (str) – TimeMatchStrategy to define how to match startTimestamp and endTimestamp with provided timeFieldStrategies (default any)

  • timeFieldStrategy (list) – TimeFieldStrategy to define which timestamp field(s) to match. (default createdTimestamp)

  • sortBy (list) – List of properties to sort by (prefix with “-” to sort descending).

  • includeFlags (list) – Only include objects which have includeFlags set.

  • excludeFlags (list) – Exclude objects which have excludeFlags set.

  • includeSupernet (bool) – Network in search criteria will be searched for matching supernets (default true)

  • includeSubnet (bool) – Network in search criteria will be searched for matching subnets (default true)

  • json – return the response’s body as a dict parsed from json. True by default. If set to false, the raw requests.Response object will be returned.

  • verify – path to a certificate bundle or boolean indicating whether SSL verification should be performed.

  • apiKey – Argus API key.

  • authentication – authentication override

  • server_url – API base URL override

  • body – body of the request. other parameters will override keys defined in the body.

  • api_session – session to use for this request. If not set, the global session will be used.

Raises
Returns

requests.Response object or dictionary translated from JSON

argus_api.lib.customernetworks.v1.network.unverify_customer_network(networkID: int, json: bool = True, verify: Optional[bool] = None, proxies: Optional[dict] = None, apiKey: Optional[str] = None, authentication: Optional[dict] = None, server_url: Optional[str] = None, body: Optional[dict] = None, api_session: Optional[ArgusAPISession] = None) → dict#

Unverifies a verified customer network (PUBLIC)

Parameters

  • networkID (int) – ID of network to unverify

  • json – return the response’s body as a dict parsed from json. True by default. If set to false, the raw requests.Response object will be returned.

  • verify – path to a certificate bundle or boolean indicating whether SSL verification should be performed.

  • apiKey – Argus API key.

  • authentication – authentication override

  • server_url – API base URL override

  • body – body of the request. other parameters will override keys defined in the body.

  • api_session – session to use for this request. If not set, the global session will be used.

Raises
Returns

dictionary translated from JSON

argus_api.lib.customernetworks.v1.network.update_customer_network(networkID: int, location: str = None, description: str = None, flagsToSet: str = None, flagsToEnable: str = None, flagsToDisable: str = None, zone: str = None, json: bool = True, verify: Optional[bool] = None, proxies: Optional[dict] = None, apiKey: Optional[str] = None, authentication: Optional[dict] = None, server_url: Optional[str] = None, body: Optional[dict] = None, api_session: Optional[ArgusAPISession] = None) → dict#

Update customer network (PUBLIC)

Parameters

  • networkID (int) – ID of network to update

  • location (str) – DEPRECATED. Location ID or short name of the location where the network is located

  • description (str) – Description of the customer network. Maximum number of characters is 255.

  • flagsToSet (list) – Flags to set for the network. This property takes precedence over the content of flagsToEnable and flagsToDisable properties. A permission check if performed to verify that the user is allowed to set the flags, and disable any flags already present on the network.

  • flagsToEnable (list) – Flags to enable for the network. A permission check if performed to verify that the user is allowed to set the flags

  • flagsToDisable (list) – Flags to disable for the network. A permission check if performed to verify that the user is allowed to disable the flags

  • zone (str) – Zone of the network

  • json – return the response’s body as a dict parsed from json. True by default. If set to false, the raw requests.Response object will be returned.

  • verify – path to a certificate bundle or boolean indicating whether SSL verification should be performed.

  • apiKey – Argus API key.

  • authentication – authentication override

  • server_url – API base URL override

  • body – body of the request. other parameters will override keys defined in the body.

  • api_session – session to use for this request. If not set, the global session will be used.

Raises
Returns

dictionary translated from JSON

argus_api.lib.customernetworks.v1.network.verify_customer_network(networkID: int, json: bool = True, verify: Optional[bool] = None, proxies: Optional[dict] = None, apiKey: Optional[str] = None, authentication: Optional[dict] = None, server_url: Optional[str] = None, body: Optional[dict] = None, api_session: Optional[ArgusAPISession] = None) → dict#

Verifies an unverified customer network (PUBLIC)

Parameters

  • networkID (int) – ID of network to verify

  • json – return the response’s body as a dict parsed from json. True by default. If set to false, the raw requests.Response object will be returned.

  • verify – path to a certificate bundle or boolean indicating whether SSL verification should be performed.

  • apiKey – Argus API key.

  • authentication – authentication override

  • server_url – API base URL override

  • body – body of the request. other parameters will override keys defined in the body.

  • api_session – session to use for this request. If not set, the global session will be used.

Raises
Returns

dictionary translated from JSON