Index
armis_sdk.entities.site.Site
Bases: BaseEntity
The Site entity represents a physical location at the customer's environment.
Attributes:
| Name | Type | Description |
|---|---|---|
id |
int | None
|
The id of the site. |
name |
str | None
|
The name of the site. |
lat |
float | None
|
The latitude coordinate of the physical location of the site on earth. |
lng |
float | None
|
The longitude coordinate of the physical location of the site on earth. |
location |
str | None
|
The name of the location of the site, such as an address. |
parent_id |
int | None
|
The id of the parent site. |
tier |
str | None
|
The tier of the site. |
asq_rule |
AsqRule | None
|
The ASQ rule of the site. |
network_equipment_device_ids |
Annotated[list[int] | None, BeforeValidator(ensure_list_of_ints)]
|
The ids of network equipment devices associated with the site. |
integration_ids |
Annotated[list[int] | None, BeforeValidator(ensure_list_of_ints)]
|
The ids of the integration associated with the site. |
children |
list[Site]
|
The sub-sites that are directly under this site |
id = Field(strict=False, default=None)
class-attribute
instance-attribute
The id of the site.
name = None
class-attribute
instance-attribute
The name of the site.
lat = Field(frozen=True, default=None)
class-attribute
instance-attribute
The latitude coordinate of the physical location of the site on earth.
This field is read-only and is automatically derived from the
location field.
Example: 37.7900103
lng = Field(frozen=True, default=None)
class-attribute
instance-attribute
The longitude coordinate of the physical location of the site on earth.
This field is read-only and is automatically derived from the
location field.
Example: -122.4007818
location = None
class-attribute
instance-attribute
parent_id = Field(strict=False, default=None)
class-attribute
instance-attribute
The id of the parent site.
tier = None
class-attribute
instance-attribute
The tier of the site.
asq_rule = Field(default=None)
class-attribute
instance-attribute
The ASQ rule of the site.
network_equipment_device_ids = None
class-attribute
instance-attribute
The ids of network equipment devices associated with the site.
integration_ids = None
class-attribute
instance-attribute
The ids of the integration associated with the site.
children = Field(default_factory=list)
class-attribute
instance-attribute
The sub-sites that are directly under this site
(their parent_id will match this site's id).