nav[aria-label="Primary Navigation"] { padding: 0; & ul { list-style: none; width: 100%; display: flex; flex-direction: row; justify-content: start; align-items: start; gap: 30px; padding: 0; & li { margin: 0; } & ul li { list-style: none; } } }

AGS admin scripting help

JamesCrandall

I'm trying to build some simple service checks (map, feature and gp services) that are published on our ArcGIS Server site(s). Example: Check a folder for stopped services—Documentation (10.3 and 10.3.1) | ArcGIS for Server is what I'm attempting to implement but having difficulty with the request at fetching the token.

I've been provided with the serverName and serverPort parameters (lines 22 and 23 of the sample code) by our AGS admin but I keep tripping the error at line 137. If I print the response.status it shows a response of 302 and response.reason is "Found".

Any input or success implementing this script?

Encontre mais publicações marcadas com

Accepted answers

JamesCrandall

I ditched using the REST API calls (it's infuriating to navigate and determine all of the correct required server parameters). Simply opted for simplicity and accomplished this with urllib.open and properly setting up each individual url, taking care in constructing each one correctly.

The REST API is overly complicated for my needs.

All comments

SubuSwaminathan1

Hello Avinash,

I did not realize that you had made a separate post till I followed you. Thanks for the script. Now I can see what you have done.

I used urllib2 to access the right server URL for https/ssl enabled services.

Regards

Subu

JamesCrandall

I can see the delay being a requirement. However, my scripting was for very basic reporting on service statuses (stopped or started) and that's it, I really have no need to actually stop/start them.

Our organization is about 6 months into building out our AGS environment(s) with new waves of more data migrating out of old sde into new sde db's, more map/feature service publishing is planned. As we found in the first wave of this, not everything is published perfectly and requires making adjustments, so when you have other products being developed and built from these services that are prone to change (schema, attributes, layer indexes, etc.), those products tend to be susceptible to breakage. So... by incorporating a single-point GP service that has the single job of checking to see if a service is stopped or started, error and process handling can be built into the apps using those services.

Anonymous User

Hello,

Please use this script and make stop command in place of start
Also you can scheduled stop and start operation in given folder services.

Start ArcGIS server Map services using python script & used in automation jobs

SubuSwaminathan1

James,

Have you found that services need time to stop or that ArcGIS Server needs to recover before the next stop or start request is sent in. I was testing the stop functionality with a large number of services and soon found that I need to introduce a delay if I can expect ArcGIS Server to respond to each request in a reliable fashion. So this meant that I had to increase the token's expiration time as well as insert a time delay to ensure that the server is ready to respond. Otherwise I get an urllib error saying that the process has timed out. Still early days in terms of using this in production in our org.

Thanks

Subu

SubuSwaminathan1

I agree with Rebecca that being able to hide/encrypt or encapsulate the admin user credentials in a secure fashion is the most important piece that is missing. Once that is in place, being able to able to access secured services, https, service status and all others all become more useful. In fact looking at the this thread and the contributions, most of the rest has been achieved and folks are willing to share with the community.

Thanks

Subu

JamesCrandall

We just have a simple need to check services to see STOPPED/STARTED status --- that's really it. Couple of reasons why:

1. To build a dashboard that can be displayed on a monitor hanging on the wall. Pretty simple .aspx page or something like that showing Red & Green for stopped/started services.

2. We have applications developed with the JavaScript API that other departments within the organization build and these utilize our ArcGIS Server services (map, feature & GP services). With the simple code below we published as a GP service that those applications can check against to see status and handle the appropriate methods if at runtime of their application it experiences a stopped service. Again, pretty simple yet has a lot of value.

Part of the GP service that checks service status:

def reviewRunning(token):

    query_dict = { "f": "json", "token": token['token'] }  

    # query your services url  
    jsonResponse = urllib.urlopen(URL, urllib.urlencode(query_dict))
    rooturl = agsurl + site + "/admin/services"
    rootresp = json.loads(urllib.urlopen(rooturl + "?f=json", urllib.urlencode(query_dict)).read())
    fldrs = rootresp['folders']
    for fldr in fldrs:
       fldrurl = agsurl + site + "/admin/services/" + fldr  

       query_dict = { "f": "json", "token": token['token'] }   
       svcresp = json.loads(urllib.urlopen(fldrurl + "?f=json", urllib.urlencode(query_dict)).read())
       svcs = svcresp['services']
       for svc in svcs:
           svcname = svc['serviceName']
           svctype = svc['type']

           query_dict = { "f": "json", "token": token['token'] }

           svcstatusurl =  fldrurl + "/" + svcname + "." + svctype + "/status"
           svcstatusresp = json.loads(urllib.urlopen(svcstatusurl + "?f=json", urllib.urlencode(query_dict)).read())

           svcstatus = svcstatusresp['realTimeState']
           print svcname, svctype, svcstatus

Anonymous User

i am using current version of AGS admin tool with the help of this tool I am to list down all stop services without error.

and also create one Python script to generate reports of all map services.
if you require then i will share with you.

thanks.

RebeccaStrauch__GISP

Hi Kevin Hibma ,

I'm making (slow) progress using the sample James Crandall provided above (Many thanks for that James!)

Quick (?) question(s)...

I was looking at the samples for ListingMapServices ArcGIS Help (10.2, 10.2.1, and 10.2.2) but only seems to pass the "unsecure" services, even if I pass the token. Your "Stop, Start, Delete services" will list them all, but is not filtered for those that are STARTED.

How can I get a script to return all of the services (secured or not), but filtered for only those that are STARTED? Kind of a combo of the above....but also almost opposite of both.
I might have better luck once I have it as a tool, but I'm still testing as snippets in the python window

Again, long term goal (simplified)...stop only those services that are accessing the FGDB that I need to update..replace the FGDB...then start just those back up. All while keeping credentials secure. Simple...right. lol. I may need to look at the link James had at the beginning of the thread to see if I can do the opposite of what it is supposed to do.

On that same "secure" thought....is there anyway to block things being written to the results table....or to programatically remove entries from the script? did decide that rather than using the "agsurl " as shown in James' script, if I use the local server name and port 6080, that should prevent access from outside the network (and thinking maybe a local server account??).

KevinHibma

This is a great suggestion. Having user/password saved in plain text is just bad form. And sadly, I've encouraged that in places (GitHub - arcpy/update-hosted-feature-service: Update and overwrite a hosted feature service on ArcGIS.com ) Maybe I'll try to update that sample with your approach. And, yes, its still very possible for someone to find out the credentials. However, any sort of security is better than no security. Thanks, James.

JamesCrandall

No problem, hijack away!

Here's an idea to keeping credentials out of things. Well, sort of.

You could just setup a simple .ini file to hold any credentials and then use base64 library in the python scritping. It's not a 100% secure approach, but it'd keep any hardcoded credentials out of the codebase and some low-level secuity using base64 to encode/decode that will essentially hide any variable values from view that might be set. Like so:

*** create a "settings.ini" file and save it in the same directory as the .py script
[AGS]
USER = someusername
PASS = somepassword

The implement base64 and ConfigPaser in your .py scripting:

import ConfigParser
import base64
# Find and gather settings from the settings.ini file
localPath = sys.path[0]
settingsFile = os.path.join(localPath, "settings.ini")
config = ConfigParser.ConfigParser()
config.read(settingsFile)

# Get encoded credentials
uname_encoded = base64.b64encode(config.get( 'AGS', 'USER'))
pwd_encoded = base64.b64encode(config.get('AGS', 'PASS'))

# use the encoded credentials for any login parameters
# for example, build the URL with credentials for the REST API
agsurl = 'https://yourAGSaddress'
site = '/arcgis'
URL = agsurl + site + "/rest/services"
      
# obtain a token  
referer = agsurl
query_dict = { 'username': base64.b64decode(uname_encoded), 'password': base64.b64decode(pwd_encoded), 'referer': referer }  
query_string = urllib.urlencode(query_dict)
url = agsurl + site + "/tokens/generateToken"
token = json.loads(urllib.urlopen(url + "?f=json", query_string).read()) 

#...blah blah blah you get the idea

KevinHibma

I just came across this post and realize you might have a path forward.

Just a note though - I've been trying to make time to refresh the toolkit. That includes introducing proper HTTPS support. If you're interested in it before its "done", its in a branch here: GitHub - khibma/ArcGISAdministrationToolkit at devupdates

I'm close to being done. I just need to do some more testing. After that I'll update the arcgis.com sample with the newest and greatest.

RebeccaStrauch__GISP

mine runs using the machine name as input and runs again sucure and non-secure services. I run the tool in the toolbox, then copy the snippet for input into my own script....the only thing I don't like just using this as default is the admin password is part of the snippet (in the results tab too), so be aware of that.

sample of the script...with fake folder names for demonstration....

arcpy.StopStartService(Server_Name="<machinename>",Port="6080",
  Admin_User="<adminUser>",Admin_Password="<adminPsw>",
  Stop__Start__Delete="Stop",
  Service_List="some_gp//ExtractData.GPServer;print//dwcGeoPDF.GPServer;our_public//GMUSubunits.MapServer;our_secure//uculines.MapServer")

If you run it once "manually" with Stop, then you can copy and change to Start to you don't always start up the services you don't want started.

JamesCrandall

This looks like a really comprehensive tool set! But it's a bit much for what we need I think. To go from just running a simple script to check what services are stopped/running to this is pretty extreme.

I'm not sure why the example script doesn't play nice with https. Seems like something do-able to overcome.

JamesCrandall

Thanks!

Have you had a chance to setup the toolkit against HTTPS? I'd think we'd run into the same issues I'm hitting with the example REST API script.

RebeccaStrauch__GISP

Just to make sure you aren't reinventing the wheel, have you checked out

Downloadable tools for ArcGIS Server administration | ArcGIS Blog

http://www.arcgis.com/home/item.html?id=12dde73e0e784e47818162b4d41ee340

JamesCrandall

I may revisit the REST API as there are some other complications to overcome with the approach I took.

The issue with the REST API example is that it doesn't implement the requests library and instead uses urllib. Normally not an issue, however when dealing with https and TLS & SSL things start to just not work as originally written! This sends you down an entirely different path --- I may just try to re-write the sample using requests instead.

JamesCrandall

The REST API is overly complicated for my needs.

Participe da Conversa

Membros conectados podem postar, seguir atualizações e mais. Novo aqui? Registre uma conta gratuita.

Links Rápidos

Community Help
Find useful guides, FAQs, and documents to help you navigate and make the most of Esri Community.